Atlas commands
On this page
- atlas init
- atlas doctor
- atlas agents
- atlas agents status
- atlas agents project
- atlas agents forget
- atlas agents install
- atlas agents remove
- atlas menubar
- atlas screenshot
- atlas windows
- atlas elements
- atlas apps
- atlas status
- atlas activity
- atlas click
- atlas type
- atlas key
- atlas move
- atlas drag
- atlas scroll
- atlas input
- atlas open
- atlas close
- atlas cleanup
- atlas wait
- atlas run
- atlas job
- atlas job start
- atlas job list
- atlas job log
- atlas job stop
- atlas collect
- atlas readiness
- atlas environment
- atlas environment profile
- atlas environment run
- atlas environment apply
- atlas environment list
- atlas environment rollback
- atlas environment discover
- atlas install-app
- atlas verify-native
- atlas switch
- atlas monitor
- atlas restart
- atlas logout
- atlas start-input
- atlas update
- atlas uninstall
- atlas install
- atlas setup
- atlas config
- atlas agent-guide
Generated from atlas --help. Every command prints JSON when its output is not a terminal (or with --json) and exits non-zero on failure.
atlas init
Set Atlas up, step by step (safe to run again).
Helper account, first sign-in, permissions, the helper job and input.
Usage: atlas init [OPTIONS]
Options:
-h, --help
Print help (see a summary with '-h')
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings fileatlas doctor
Check that everything is ready, and say what to fix if not
Usage: atlas doctor [OPTIONS]
Options:
--verbose
Include every check and the helper's full status (in --json too)
--login-timing
Show how long the last login of the past two hours took, step by step
-h, --help
Print help
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings file
Examples:
atlas doctor
atlas doctor --verbose
atlas doctor --login-timingatlas agents
Connect Claude Code and Codex, or show which are connected.
Adds a plugin that teaches the agent to use Atlas and guides setup.
Usage: atlas agents [OPTIONS] [COMMAND]
Commands:
status Which agents are on this Mac and whether Atlas is connected
project Tell a project's agents to test with Atlas: adds a short section to its AGENTS.md, and to a CLAUDE.md it has that does not include AGENTS.md
forget Take the Atlas section out of a project's AGENTS.md and CLAUDE.md
install Connect Atlas to coding agents (all installed by default)
remove Disconnect Atlas from coding agents
help Print this message or the help of the given subcommand(s)
Options:
-h, --help
Print help (see a summary with '-h')
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings file
Examples:
atlas agents
atlas agents install
atlas agents projectatlas agents status
Which agents are on this Mac and whether Atlas is connected.
JSON keeps Claude Code (`claude`) and the Claude app (`claude-app`) as separate connection parts. Atlas.app groups them into one Claude row, connected only when every installed part is connected.
Usage: atlas agents status [OPTIONS]
Options:
--brief
One plain line for an agent's session start
-h, --help
Print help (see a summary with '-h')
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings fileatlas agents project
Tell a project's agents to test with Atlas: adds a short section to its AGENTS.md, and to a CLAUDE.md it has that does not include AGENTS.md
Usage: atlas agents project [OPTIONS] [DIR]
Arguments:
[DIR]
The project folder (default: this one)
Options:
-h, --help
Print help
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings fileatlas agents forget
Take the Atlas section out of a project's AGENTS.md and CLAUDE.md
Usage: atlas agents forget [OPTIONS] [DIR]
Arguments:
[DIR]
The project folder (default: this one)
Options:
-h, --help
Print help
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings fileatlas agents install
Connect Atlas to coding agents (all installed by default).
Use --claude --app together to connect both Claude parts. Select only the parts installed on this Mac. JSON reports each part's result by id.
Usage: atlas agents install [OPTIONS]
Options:
--claude
Only Claude Code
--codex
Only Codex
--opencode
Only opencode
--pi
Only Pi
--cursor
Only Cursor
--app
Only the Claude app
-h, --help
Print help (see a summary with '-h')
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings fileatlas agents remove
Disconnect Atlas from coding agents.
Use --claude --app together to disconnect both Claude parts.
Usage: atlas agents remove [OPTIONS]
Options:
--claude
Only Claude Code
--codex
Only Codex
--opencode
Only opencode
--pi
Only Pi
--cursor
Only Cursor
--app
Only the Claude app
-h, --help
Print help (see a summary with '-h')
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings fileatlas menubar
Show the helper in the menu bar, to watch it or take control.
The menu bar runs on its own, so the terminal can close. Quit it from its menu; that stops its viewer and releases control.
Usage: atlas menubar [OPTIONS]
Options:
--port <PORT>
Local port for the viewer it opens
[default: 8765]
--render <DIR>
Instead, draw the panel in light and dark to PNGs in DIR and exit
--login <on|off|status>
Instead, turn "Open at Login" on or off, or report it
[possible values: on, off, status]
-h, --help
Print help (see a summary with '-h')
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings fileatlas screenshot
Save a screenshot of the helper's screen, an app's windows or a region.
Reports origin and pointsPerPixel: the image's pixel (px, py) is the display point (origin.x + px × pointsPerPixel, origin.y + py × pointsPerPixel). With --app the picture holds the app's windows, its sheets, panels and open menus with a small margin; overlapping lists other apps' windows in front of them (take a full screenshot to see those).
Usage: atlas screenshot [OPTIONS]
Options:
--app <APP>
Application name: the one process of that name with a window, or the app in front
--pid <PID>
Exact process ID, for apps with several processes
--region <X,Y,W,H>
Only this part of the display: X,Y,W,H in display points, widened to whole points
--max-dimension <MAX_DIMENSION>
Shrink the longer side to at most this many pixels; 0 keeps the full size. Without it: at most 1456 and one pixel per display point
--new-file
Save a new file even when nothing changed since the last screenshot
-h, --help
Print help (see a summary with '-h')
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings fileatlas windows
List the helper's windows, front to back.
Every app's windows, floating panels and alerts. --all adds menus, the menu bar, the Dock and other system layers.
Usage: atlas windows [OPTIONS]
Options:
--app <APP>
Only windows of this app
--title <TITLE>
Only windows whose title contains this
--all
Include menus, the menu bar, the Dock and other system layers
-h, --help
Print help (see a summary with '-h')
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings file
Examples:
atlas windows --app TextEditatlas elements
List an app's buttons, fields and other elements.
Lists accessibility elements of the app's windows: role, name, value, click point (at) and size, with each window listed once; also the items of a menu the app has open (menu: true, with a check mark as mark) and, while the app is in front, its menu bar titles. more says how many matching elements were left out.
Usage: atlas elements [OPTIONS]
Options:
--app <APP>
Application name: the one process of that name with a window, or the app in front
--pid <PID>
Exact process ID, for apps with several processes
--role <ROLE>
Only elements with this accessibility role, for example AXButton
--name <NAME>
Only elements with this exact title, label text, description or identifier
--max <MAX>
Show at most this many elements
[default: 50]
--full
Show every attribute the scan read, as it read it
-h, --help
Print help (see a summary with '-h')
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings file
Examples:
atlas elements --app TextEdit --role AXButtonatlas apps
List the apps open in the helper.
Lists apps with a Dock icon and menu bar apps that are not part of macOS; `more` says how many other processes were left out.
Usage: atlas apps [OPTIONS]
Options:
--all
List every process, macOS's own background ones too
-h, --help
Print help (see a summary with '-h')
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings fileatlas status
Show the helper: who it is, where it is and what it may do
Usage: atlas status [OPTIONS]
Options:
-h, --help
Print help
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings fileatlas activity
List what this agent session did in the helper.
Its recent actions, its screenshots, the copies open made that are still there, the environment plans it applied and not yet rolled back, whether an action of its own is unknown, and each task it named with ATLAS_TASK=NAME. Claude Code, Codex, opencode and Pi name their session themselves; elsewhere set ATLAS_SESSION=NAME. Without a session, or with --all, every session's. It only reads: it works while another agent or the person has control, or after a Stop.
Usage: atlas activity [OPTIONS]
Options:
--all
Every session's, not only this one's
--session <KEY>
Another session's, by the key --all lists
--limit <N>
How many recent actions to list: 10 unless given, at most 50
[default: 10]
-h, --help
Print help (see a summary with '-h')
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings file
Examples:
atlas activity
atlas activity --allatlas click
Click a point, or exactly one element of an app.
Click at display point X Y (origin + screenshot pixels × pointsPerPixel), or on exactly one accessibility element of an app with --app and --name/--role. With X Y, --app or --pid sends the click only if that app's window is the top one at the point, and --window only if that window is.
Usage: atlas click [OPTIONS] [X] [Y]
Arguments:
[X]
Display point X (origin + screenshot pixels × pointsPerPixel)
[Y]
Display point Y
Options:
--app <APP>
Application name: the one process of that name with a window, or the app in front
--pid <PID>
Exact process ID, for apps with several processes
--window <N>
Only if window N (from atlas windows) is the top one at the point. Nothing is sent otherwise
--name <NAME>
Exact element title, label text, description or identifier
--role <ROLE>
Accessibility role, for example AXButton
--button <BUTTON>
Which mouse button
[default: left]
[possible values: left, middle, right]
--count <COUNT>
Clicks in a row, 1 to 5: 2 for a double click
[default: 1]
--modifiers <MODIFIERS>
Comma-separated: cmd, ctrl, alt, shift, fn
-h, --help
Print help (see a summary with '-h')
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings file
Examples:
atlas click --app TextEdit --name Save
atlas click 1200 880atlas type
Type text.
The text is typed as given: a real newline or tab in it (in a shell, $'one\ntwo') or on standard input arrives as a line break or tab, while the two characters \n are typed as they are. Long text is typed in parts without breaking characters, and Atlas keeps control until the last part, so no other input lands in between. With --app or --pid, text is typed only while that app has keyboard focus, and with --window or --field only while that window or field has it too, checked before every 16 characters; Atlas stops at the first check that fails.
Usage: atlas type [OPTIONS] [TEXT]
Arguments:
[TEXT]
The text to type
Options:
--stdin
Read the text from standard input instead
--app <APP>
Application name: the one process of that name with a window, or the app in front
--pid <PID>
Exact process ID, for apps with several processes
--window <N>
Only if window N (from atlas windows) has keyboard focus, with no sheet over it. Nothing is sent otherwise
--field <NAME>
Only if the focused field has this name, as atlas elements --name matches it. Nothing is sent otherwise
-h, --help
Print help (see a summary with '-h')
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings file
Examples:
atlas type "hello"atlas key
Press keys, for example cmd+s or escape.
Keys are pressed in order: `key cmd+s` or `key escape return`. A key is a letter, digit or punctuation mark, or one of return, tab, space, escape, backspace, forwarddelete, left, right, up, down, home, end, pageup, pagedown and f1 to f12; the plus key is written + on its own or at the end of a chord (cmd++). With --app or --pid, each key is pressed only while that app has keyboard focus; --window and --field are checked before the first key, since a key may move them on purpose.
Usage: atlas key [OPTIONS] <KEYS>...
Arguments:
<KEYS>...
Keys or chords such as cmd+s, escape, return, shift+tab
Options:
--app <APP>
Application name: the one process of that name with a window, or the app in front
--pid <PID>
Exact process ID, for apps with several processes
--window <N>
Only if window N (from atlas windows) has keyboard focus, with no sheet over it. Nothing is sent otherwise
--field <NAME>
Only if the focused field has this name, as atlas elements --name matches it. Nothing is sent otherwise
-h, --help
Print help (see a summary with '-h')
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings file
Examples:
atlas key cmd+s
atlas key escape returnatlas move
Move the pointer to a point
Usage: atlas move [OPTIONS] <X> <Y>
Arguments:
<X>
Display point X
<Y>
Display point Y
Options:
-h, --help
Print help
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings file
Examples:
atlas move 640 400atlas drag
Drag from one point to another.
What is dragged (a window, a slider's knob, a selection) moves by exactly the distance between the points; the button itself is released up to one point past the end, in the direction of travel, never off the display. Drag-and-drop onto a target (selected text, files, list items) does not begin in the helper: macOS starts such a drag only from a real mouse. With --app or --pid, nothing is sent unless that app's window is the top one at the start point and at the end point; with --window, unless that window is the top one at the start point.
Usage: atlas drag [OPTIONS] <FROM_X> <FROM_Y> <TO_X> <TO_Y>
Arguments:
<FROM_X>
Start point X
<FROM_Y>
Start point Y
<TO_X>
End point X
<TO_Y>
End point Y
Options:
--button <BUTTON>
Which mouse button
[default: left]
[possible values: left, middle, right]
--app <APP>
Application name: the one process of that name with a window, or the app in front
--pid <PID>
Exact process ID, for apps with several processes
--window <N>
Only if window N (from atlas windows) is the top one at the start point. Nothing is sent otherwise
-h, --help
Print help (see a summary with '-h')
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings file
Examples:
atlas drag 100 200 400 200atlas scroll
Scroll at a point.
Scroll at X Y by lines, as a mouse wheel's notches (about 10 points each, as the app has it); negative values scroll up or left. With --app or --pid, nothing is sent unless that app's window is the top one at the point, and with --window unless that window is.
Usage: atlas scroll [OPTIONS] <X> <Y>
Arguments:
<X>
Display point X
<Y>
Display point Y
Options:
--dx <DX>
Lines to scroll sideways, at most 100; negative scrolls left
[default: 0]
--dy <DY>
Lines to scroll, at most 100; negative scrolls up
[default: 0]
--app <APP>
Application name: the one process of that name with a window, or the app in front
--pid <PID>
Exact process ID, for apps with several processes
--window <N>
Only if window N (from atlas windows) is the top one at the point. Nothing is sent otherwise
-h, --help
Print help (see a summary with '-h')
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings file
Examples:
atlas scroll 640 400 --dy 3atlas input
Send several actions at once (a JSON array, or @path/to/actions.json).
Each action is an object with a "type": move {x, y}; click {x, y, button?, count?, modifiers?}; drag {fromX, fromY, toX, toY, button?}; scroll {x, y, dx?, dy?}; type {text}; key {key}; wait {ms}. Up to 32 actions that finish within two seconds; coordinates are display points, a click is 1 to 5 clicks, a scroll at most 100 lines, text at most 256 characters, a wait at most 250 ms. With --app or --pid, each action is checked before it starts, as type, key, click, scroll and drag check it, and a move at its point. Example: [{"type":"click","x":200,"y":120},{"type":"type","text":"hi"}]
Usage: atlas input [OPTIONS] <ACTIONS>
Arguments:
<ACTIONS>
A JSON array of actions, or @path/to/actions.json
Options:
--app <APP>
Application name: the one process of that name with a window, or the app in front
--pid <PID>
Exact process ID, for apps with several processes
-h, --help
Print help (see a summary with '-h')
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings file
Examples:
atlas input @actions.jsonatlas open
Open an app, files or URLs in the helper
Usage: atlas open [OPTIONS] [FILE|URL]...
Arguments:
[FILE|URL]...
Files or URLs to open
Options:
--app <APP>
The app to open (or to open the targets with)
--env <NAME=VALUE>
A variable for the app's environment when it launches (repeat for more)
-h, --help
Print help
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings file
Examples:
atlas open --app TextEdit
atlas open ./build/Debug/MyApp.app --env DEBUG=1
atlas open --app "Google Chrome" https://example.comatlas close
Quit an app in the helper and remove the copies `open` made for it.
The app quits at once, without asking to save: save first (key cmd+s). --all quits every app left open, another agent's too: use it only when the person asks. Atlas and macOS's own in /System/Library (Finder among them) stay.
Usage: atlas close [OPTIONS] <--app <APP>|--all>
Options:
--app <APP>
The app's name, as `atlas apps` lists it
--all
Quit every app left open, another agent's too (not Atlas or macOS's own)
-h, --help
Print help (see a summary with '-h')
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings file
Examples:
atlas close --app TextEditatlas cleanup
See what this task left in the helper, and clean it up with --apply.
Lists the copies into the helper this task applied, the apps it installed, the copies it opened and the apps running from them. With --apply it quits those apps, rolls the copies into the helper back newest first, moves the installs aside in the helper (held, and removed after 7 days), removes the copies, and reports what it kept and why. Run it again to finish what is left. Apps opened by name that still run are listed, not quit.
Usage: atlas cleanup [OPTIONS]
Options:
--apply
Do it; otherwise only show what would be done
--session <KEY>
An ended session's work, by the key atlas activity --all shows
--task <KEY>
Only one task, by the key atlas activity shows for it
-h, --help
Print help (see a summary with '-h')
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings file
Examples:
atlas cleanup
atlas cleanup --apply
atlas cleanup --session 3f9a1c07b2e4 --applyatlas wait
Wait for a window to appear (or, with --gone, to close)
Usage: atlas wait [OPTIONS]
Options:
--app <APP>
A window of this app
--title <TITLE>
A window whose title contains this
--gone
Wait for the window to close instead
--timeout <TIMEOUT>
Seconds, at most 86400 (a day)
[default: 10]
-h, --help
Print help
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings file
Examples:
atlas wait --app TextEdit
atlas wait --title Save --goneatlas run
Run a command in the helper and print its output.
The command starts in the helper's home and finds programs where readiness looks for them: the helper's .local/bin and .cargo/bin, Homebrew, /usr/local/bin and the system folders. It is stopped after --timeout seconds (20 unless given, at most 600). Other agents may act while it runs; recovery, restart and updates answer busy until it ends. Atlas exits 1 when the command's exit code is not 0 or it was stopped, with the reply still ok. For a server or worker that must keep running, use atlas job start.
Usage: atlas run [OPTIONS] -- <COMMAND>...
Arguments:
<COMMAND>...
The program and its arguments, after `--`
Options:
--timeout <SECONDS>
Seconds before the command is stopped, 1 to 600
[default: 20]
-h, --help
Print help (see a summary with '-h')
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings file
Examples:
atlas run -- /bin/sh -c 'ls "$HOME/atlas-work"'
atlas run --timeout 300 -- xcodebuild test-without-building -xctestrun Tests.xctestrunatlas job
Keep a server or worker running in the helper, and stop it.
A job starts in the helper's home like run, in a session and process group of its own, and keeps running after this command returns, for up to --timeout seconds. Atlas also ends it when the person stops agents and when the helper comes on screen. Stopping checks that it is still the same process, then ends its group and says what is left. A process the job starts that calls setsid leaves both its group and its session: Atlas neither stops it nor can always report it.
Usage: atlas job [OPTIONS] <COMMAND>
Commands:
start Start a job and print its id
list List this task's jobs; --all lists every job in the helper
log Print the end of a job's output
stop Stop a job: TERM, then KILL after --grace seconds
help Print this message or the help of the given subcommand(s)
Options:
-h, --help
Print help (see a summary with '-h')
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings file
Examples:
atlas job start --name web -- /usr/bin/python3 -m http.server 8000
atlas job list
atlas job log 7c2e91a04b3f
atlas job stop 7c2e91a04b3fatlas job start
Start a job and print its id
Usage: atlas job start [OPTIONS] -- <COMMAND>...
Arguments:
<COMMAND>...
The program and its arguments, after `--`
Options:
--name <NAME>
A short name to know it by; the program's name unless given
--timeout <SECONDS>
Seconds before Atlas stops it, 1 to 86400
[default: 3600]
-h, --help
Print help
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings fileatlas job list
List this task's jobs; --all lists every job in the helper
Usage: atlas job list [OPTIONS]
Options:
--all
-h, --help
Print help
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings fileatlas job log
Print the end of a job's output
Usage: atlas job log [OPTIONS] <ID>
Arguments:
<ID>
Options:
--bytes <BYTES>
Bytes from the end, at most 1048576
[default: 16384]
--task <KEY>
Read a job of another task, after that task's session was lost
-h, --help
Print help
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings fileatlas job stop
Stop a job: TERM, then KILL after --grace seconds
Usage: atlas job stop [OPTIONS] <ID>
Arguments:
<ID>
Options:
--grace <GRACE>
Seconds between TERM and KILL, 1 to 60
[default: 5]
--task <KEY>
Stop a job of another task, after that task's session was lost
-h, --help
Print help
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings fileatlas collect
Copy files a task made in the helper into a private folder here.
Each FILE is a regular file owned by the helper, in its home (a path relative to it) or in /tmp, that has not changed for two seconds. The reply gives each copy's path, size and SHA-256. The file in the helper is left as it is.
Usage: atlas collect [OPTIONS] <FILE>...
Arguments:
<FILE>...
Files in the helper, at most 16
Options:
--max-size <SIZE>
The largest file accepted, such as 200M (64M unless given, at most 1G)
[default: 64M]
-h, --help
Print help (see a summary with '-h')
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings file
Examples:
atlas collect atlas-work/report.pdf
atlas collect --max-size 200M atlas-work/build.zipatlas readiness
Check that tools and apps are ready in the helper
Usage: atlas readiness [OPTIONS]
Options:
--tool <NAME>
A command-line tool to check (repeat for more)
--app <NAME>
An app to check (repeat for more)
-h, --help
Print help
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings file
Examples:
atlas readiness --tool git
atlas readiness --tool git --app Xcodeatlas environment
Copy selected settings and files into the helper.
Preview a one-way copy into the helper. The TOML manifest lists [[files]] tables: source (absolute or relative to the manifest), target (an ASCII path inside the helper's home) and optional executable. Quit apps that write these files before applying. A different file already in the helper, or one changed there after Atlas copied it, is a conflict; a target inside, around or differing only in case from another, or from a file copied earlier, is refused. Rollback undoes it, leaves a file changed in the helper since as it is, and deletes the copies Atlas kept for it. Accounts, sign-ins and running apps' databases are never copied.
Usage: atlas environment [OPTIONS] [MANIFEST]
atlas environment <COMMAND>
Commands:
profile Freeze selected files, exported variables and readiness requirements
run Run a command with the selected helper environment and helper tool paths
apply Copy a previewed plan into the helper (or finish one that stopped)
list List copies into the helper and their state, newest first
rollback Show what undoing a copy would do, or undo it with --apply
discover Inspect selected tools, apps, variables and reference paths without launching them
help Print this message or the help of the given subcommand(s)
Arguments:
[MANIFEST]
TOML manifest listing only the files to provision
Options:
--apply
Apply the previewed changes; otherwise inspect without changing selected files
-h, --help
Print help (see a summary with '-h')
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings fileatlas environment profile
Freeze selected files, exported variables and readiness requirements
Usage: atlas environment profile [OPTIONS] <PROFILE>
Arguments:
<PROFILE>
TOML profile (version = 2) of files, tools, applications, environment and references
Options:
--apply
Apply it; otherwise only preview
-h, --help
Print help
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings fileatlas environment run
Run a command with the selected helper environment and helper tool paths.
It is stopped after --timeout seconds (20 unless given, at most 600).
Usage: atlas environment run [OPTIONS] -- <COMMAND>...
Arguments:
<COMMAND>...
The program and its arguments, after `--`
Options:
--timeout <SECONDS>
Seconds before the command is stopped, 1 to 600
[default: 20]
-h, --help
Print help (see a summary with '-h')
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings fileatlas environment apply
Copy a previewed plan into the helper (or finish one that stopped)
Usage: atlas environment apply [OPTIONS] <ID>
Arguments:
<ID>
The ID the preview printed
Options:
-h, --help
Print help
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings fileatlas environment list
List copies into the helper and their state, newest first.
Shows each plan's ID, state and the files it copies, never their contents, and which session made it. Plans rolled back completely are left out unless --all.
Usage: atlas environment list [OPTIONS]
Options:
--all
Include plans rolled back completely
-h, --help
Print help (see a summary with '-h')
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings fileatlas environment rollback
Show what undoing a copy would do, or undo it with --apply
Usage: atlas environment rollback [OPTIONS] <ID>
Arguments:
<ID>
The ID the copy printed
Options:
--apply
Undo the copy; otherwise show what undoing it would do
-h, --help
Print help
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings fileatlas environment discover
Inspect selected tools, apps, variables and reference paths without launching them
Usage: atlas environment discover [OPTIONS]
Options:
--tool <TOOLS>
A tool by its bare command name, such as cat
--app <APPS>
An app by its name, such as Safari
--env <ENVIRONMENT>
Report only whether the named variable is defined, never its value
--reference <REFERENCES>
Check existing access without changing permissions
-h, --help
Print help
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings fileatlas install-app
Install an app into the helper's Applications folder for this task.
Copies an .app from this Mac into ~/Applications in the helper, never over anything already there, registers it so atlas open --app NAME finds it, and records it, so that atlas cleanup --apply moves it aside in the helper once the task is done, unless it changed meanwhile. Settings and data the app writes in the helper stay.
Usage: atlas install-app [OPTIONS] <PATH>
Arguments:
<PATH>
The .app to install
Options:
-h, --help
Print help (see a summary with '-h')
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings file
Examples:
atlas install-app ./build/Release/Probe.app
atlas open --app Probeatlas verify-native
Check that native Save and Open dialogs work in the helper.
Exercises real Save/Open dialogs with the AppKit fixture and records the outcome.
Usage: atlas verify-native [OPTIONS]
Options:
--fixture <FIXTURE>
The compiled DesktopFixture test app, where the helper can run it
[default: /Users/Shared/AtlasTests/DesktopFixture]
-h, --help
Print help (see a summary with '-h')
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings fileatlas switch
Lock the screen so you can switch to the helper.
You log in on the lock screen; Atlas never sees a password.
Usage: atlas switch [OPTIONS] [ACCOUNT]
Arguments:
[ACCOUNT]
The account you will choose on the lock screen (the helper by default)
Options:
--lock
Just lock the screen
--list
List the accounts you can switch to
--yes
Lock without asking first
-h, --help
Print help (see a summary with '-h')
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings fileatlas monitor
Watch and control the helper in Atlas's viewer window.
Starts the menu bar first when it is not running.
Usage: atlas monitor [OPTIONS]
Options:
--port <PORT>
Local port for the viewer
[default: 8765]
-h, --help
Print help (see a summary with '-h')
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings file
Examples:
atlas monitor
atlas monitor --port 8800atlas restart
Restart the helper after something went wrong.
Confirms a new hidden helper before clearing an action of unknown outcome.
Usage: atlas restart [OPTIONS]
Options:
-h, --help
Print help (see a summary with '-h')
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings fileatlas logout
Log the helper out.
Its apps quit as at any log-out; one asking to save holds it up. --force ends the session anyway. You log in to the helper again to use it.
Usage: atlas logout [OPTIONS]
Options:
--force
End the helper's session without asking its apps
--yes
Log out without asking first
-h, --help
Print help (see a summary with '-h')
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings file
Examples:
atlas logout
atlas logout --forceatlas start-input
Start (or reset) the helper's input service
Usage: atlas start-input [OPTIONS]
Options:
-h, --help
Print help
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings fileatlas update
Update Atlas, checking its signature first.
Verifies the release's checksum, Developer ID signature and version, then moves the helper onto it.
Usage: atlas update [OPTIONS]
Options:
--allow-unnotarized
Accept a signed release that is not notarized
--force
Reinstall even when the release is not newer
--version <VERSION>
Install this release tag instead of the latest
--check
Only say whether a newer release is out; install nothing
-h, --help
Print help (see a summary with '-h')
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings fileatlas uninstall
Remove Atlas from this Mac (asks first).
The helper is logged out first. Its account and files stay unless you pass --remove-helper; the app goes to the Trash.
Usage: atlas uninstall [OPTIONS]
Options:
--keep-config
Keep configuration, setup records and logs
--yes
Do not ask
--remove-helper
Also delete the helper account and its files, once it is logged out
-h, --help
Print help (see a summary with '-h')
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings file
Examples:
atlas uninstall
atlas uninstall --remove-helperatlas install
Put this build where the helper can run it
Usage: atlas install [OPTIONS]
Options:
-h, --help
Print help
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings fileatlas setup
Inspect or repair the helper's setup (advanced).
Without flags, report the helper account, configuration, endpoints and services without changing anything. --apply runs Atlas's own signed helper daemon as a managed LaunchAgent on a private socket directory beside the existing capture job, moves input and the configuration over once it is verified, then retires the old job, recording every step so an interruption resumes. --rollback restores the previous job and configuration.
Usage: atlas setup [OPTIONS]
Options:
--helper <HELPER>
Helper account short name. Defaults to the configured helper
--apply
Migrate (or resume migrating) to the managed private layout
--rollback
Undo an applied or interrupted migration
-h, --help
Print help (see a summary with '-h')
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings fileatlas config
Show where Atlas keeps its settings, sockets and screenshots
Usage: atlas config [OPTIONS]
Options:
-h, --help
Print help
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings fileatlas agent-guide
Print the guide agents read to use Atlas (all of it by default)
Usage: atlas agent-guide [OPTIONS]
Options:
--skill
Print the short version the agent plugins load (SKILL.md), which lists the rest
--commands
Print every command and its options (Markdown)
--errors
Print what each error code means and what to do (Markdown)
-h, --help
Print help
Global options:
--json
Print JSON (the default when the output is not a terminal)
--config <FILE>
Use another settings file
Examples:
atlas agent-guide
atlas agent-guide --skill
atlas agent-guide --errors