Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ All notable changes to Deep Field. Versions follow [Semantic Versioning](https:/

## [Unreleased]

- A `deepfield` command for the terminal: switch scenes and presets, change any setting of the running wallpaper, trigger events, control the schedule, and render stills, videos, time-lapses, GIFs and frame sequences. Install it with `DeepField.app/Contents/MacOS/DeepField install`, and see `deepfield help`.

## [0.4.7] - 2026-11-17

- Five new dither patterns under Image: Bayer 2×2, Blue noise, Halftone dots, Diagonal lines and White noise.
Expand Down
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,30 @@ Focus turns on and goes back to how it was when the Focus ends. The same choices
the Shortcuts app (**Apply Deep Field Preset** and **Set Deep Field Scene**), for any automation
you like.

### Command line

Everything above also works from a terminal. Link the `deepfield` command onto your PATH once:

```bash
/Applications/DeepField.app/Contents/MacOS/DeepField install
```

Then change the wallpaper, its settings and presets, and render stills, videos and time-lapses:

```bash
deepfield scene galaxy galaxyType=barred --fade 4 --style warp # switch, with a transition
deepfield set bloom=0.6 dither=blueNoise palette.core=#ffd27a # tweak what's showing
deepfield keys # this scene's settings
deepfield preset apply "Late Night"; deepfield event supernova
deepfield render shot.png --size 5120x2880
deepfield render video loop.mp4 --duration 8 --loop
deepfield render timelapse earth.mp4 --scene liveEarth --speed 3600
```

Changes go to the running app and show at once; when it isn't running they're saved for its next
launch. `deepfield help` lists every command, and `deepfield completion zsh|bash|fish` prints
tab completion for your shell.

### A galaxy with and without dark matter

<img src="docs/media/loops/dark-matter.gif" alt="The same galaxy with and without a dark matter halo, sped up" width="100%">
Expand Down
9 changes: 8 additions & 1 deletion Sources/DeepField/App/AppDelegate.swift
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ final class AppDelegate: NSObject, NSApplicationDelegate, NSMenuDelegate {
buildStatusItem()
NSApp.mainMenu = MainMenu.build(target: self)
if !Settings.capturingUI {
CLIServer.start()
LockScreenStill.shared.start()
Scheduler.shared.start()
LocationProvider.shared.refreshIfFollowing()
Expand Down Expand Up @@ -108,7 +109,7 @@ final class AppDelegate: NSObject, NSApplicationDelegate, NSMenuDelegate {
}
}

private func setWallpaper(_ on: Bool) {
func setWallpaper(_ on: Bool) {
Settings.wallpaperEnabled = on
buildWindows()
}
Expand Down Expand Up @@ -243,6 +244,12 @@ final class AppDelegate: NSObject, NSApplicationDelegate, NSMenuDelegate {
}
@objc private func skipSchedule() { Scheduler.shared.skip() }
@objc private func togglePause() { userPaused.toggle(); applyPause() }

/// The menu bar's Pause Animation, for the command line.
var animationPaused: Bool {
get { userPaused }
set { userPaused = newValue; applyPause() }
}
@objc func showCustomize() { CustomizeWindowController.shared.show() }
@objc private func toggleLockScreen() { ConfigStore.shared.config.lockScreenStill.toggle() }

Expand Down
1 change: 1 addition & 0 deletions Sources/DeepField/App/main.swift
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import AppKit
_ = Settings.isFirstLaunch // decided before anything below can save settings
DefaultsMigration.run() // settings saved under the old bundle identifier

CLI.runIfRequested() // `deepfield COMMAND`: runs the command and exits
LockScreenStillTest.runIfRequested() // dev: --lockscreen-still-test
PickerCheck.runIfRequested() // dev: --check-picker
DevCommands.runIfRequested() // dev CLI (--snapshot, --benchmark, ...) exits before the app starts
Expand Down
417 changes: 417 additions & 0 deletions Sources/DeepField/CLI/CLI.swift

Large diffs are not rendered by default.

Loading
Loading