Skip to content
Ant0 Docs
Create free account

Command line

Where the command comes from

ant0 talks to the same local background service as the desktop app. Start the matching desktop first and sign in with your Ant0 account. The portable archive includes Node 24, but no daemon or browser engine. ant0 daemon start still requires a separately installed ant0d on PATH. Output is a table by default; --json prints the API payload verbatim for scripts. Profiles and proxies can be addressed by id or by their exact name.

Install portable tools

  1. Use an archive actually listed for your platform and desktop version. Verify the release's signed SHA256SUMS.txt, then compare the archive's SHA-256 before extracting it. The archive's internal checksum file lets you check extracted files; it does not replace the release signature.
  2. Extract the complete top-level directory to a permanent, user-owned location. Keep bin, runtime, lib, licenses and the included manifests together. No separate Node installation or administrator access is needed.
  3. Run the platform's CLI launcher by its full path, or add that directory's bin folder to PATH. On Linux it is bin/ant0; on Windows it is bin/ant0.cmd. Check the packaged --help for commands supported by that version.

Linux archive in 0.2.0

Terminal window
tar -xzf "Ant0-tools_0.2.0_linux-x64.tar.gz"
"./Ant0-tools_0.2.0_linux-x64/bin/ant0" --help

Windows archive in 0.2.0

Terminal window
Expand-Archive -LiteralPath ".\Ant0-tools_0.2.0_windows-x64.zip" -DestinationPath ".\extracted-tools"
& ".\extracted-tools\Ant0-tools_0.2.0_windows-x64\bin\ant0.cmd" --help

After extraction, you may move or rename the complete directory. The examples below assume you named it ant0-tools. To uninstall, remove that directory and its PATH entry; the Ant0 data folder is separate.

Connecting to the background service

ant0 finds the service through the data folder: it reads ant0d.pid for the port and ant0d.token for the bearer token. Override the folder with --home (or ANT0_HOME) and the port with --port (or ANT0D_PORT). The same token authenticates calls to the local API.

Connect an MCP client

The portable MCP entrypoint uses standard input/output. Keep the matching desktop running and configure your MCP client to launch one of the commands below. Replace you, the tools directory and --home with your actual absolute paths; JSON paths do not expand ~ or shell variables.

Linux

{
"mcpServers": {
"ant0": {
"command": "/home/you/Applications/ant0-tools/bin/ant0-mcp",
"args": [
"--home",
"/home/you/.ant0"
]
}
}
}

Windows

Launch the bundled runtime directly from MCP clients. A client that spawns programs without a command shell may not be able to execute .cmd launchers.

{
"mcpServers": {
"ant0": {
"command": "C:\\Users\\you\\Tools\\ant0-tools\\runtime\\node.exe",
"args": [
"C:\\Users\\you\\Tools\\ant0-tools\\lib\\ant0-mcp.mjs",
"--home",
"C:\\Users\\you\\.ant0"
]
}
}
}

The Windows command uses runtime/node.exe with lib/ant0-mcp.mjs as its first argument. The launchers bin/ant0-mcp and bin/ant0-mcp.cmd also start the stdio server; equivalently, run ant0 --home <Ant0-home> mcp serve --stdio.

Where the matching desktop supports delegated API keys, add --credential-file and the absolute path to its private, ready credential file to the argument list. Keep credentials out of the client configuration itself. This selects delegated authority; it does not grant additional scopes or start a daemon.

Examples

Terminal window
ant0 profiles ls --json | jq '.[] | select(.status == "running") | .name'
ant0 profiles create "Shop DE" --group Shops --tag eu --proxy "http://user:pass@host:8000"
ant0 profiles start "Shop DE" # prints ws://127.0.0.1:<port>/devtools/browser/… for Playwright or Puppeteer
ant0 profiles cookies export "Shop DE" --format netscape -o shop-de.txt
ant0 proxies add --name "DE 01" "host:port:user:pass" && ant0 proxies check "DE 01"
ant0 events --replay 20 # one JSON event per line, Ctrl-C to stop

Reference

Reference snapshot of ant0 <command> --help. Run the packaged command's own --help for the exact options in the tools archive you extracted.

ant0

Usage: ant0 [options] [command]
Ant0: profile manager for Ant0 Browser (client of the local ant0d daemon)
Options:
-V, --version print the CLI version
--home <dir> data directory (default: $ANT0_HOME, else the
platform data folder)
--port <n> daemon port (default: from ant0d.pid, $ANT0D_PORT or
27100)
--json print the API payload verbatim instead of a table
--credential-file <path> private API-key file for supported reads, profile
operations or creation recovery
-h, --help display help for command
Commands:
daemon Run and inspect the local ant0d daemon
browsers Installed Ant0 Browser releases
profiles Browser profiles
trash Profiles waiting in the trash (restore with `ant0
profiles restore`)
proxies Shared proxy objects
extensions Extension library shared by profiles (unpacked
folders under <home>/extensions)
events [options] Tail the event stream (one JSON object per line;
Ctrl-C to stop)
login [options] [email] Sign in to your Ant0 account on this computer (the
daemon holds the session)
logout Sign this computer out (the licence and cloud
session are forgotten)
account Show the account and licence state of this computer
(GET /v1/licence)
licence Licence of this computer
workspace List and select account workspaces
sync Encrypted profile sync and transfers
team Folders, members and invitations
api-keys Manage delegated API keys using the local master
bearer
key-status Read current delegated key authorization status
mcp Bounded local MCP adapter (inventory reads plus
profile run/stop)
help [command] display help for command

ant0 --json

Usage: ant0 [options] [command]
Ant0: profile manager for Ant0 Browser (client of the local ant0d daemon)
Options:
-V, --version print the CLI version
--home <dir> data directory (default: $ANT0_HOME, else the
platform data folder)
--port <n> daemon port (default: from ant0d.pid, $ANT0D_PORT or
27100)
--json print the API payload verbatim instead of a table
--credential-file <path> private API-key file for supported reads, profile
operations or creation recovery
-h, --help display help for command
Commands:
daemon Run and inspect the local ant0d daemon
browsers Installed Ant0 Browser releases
profiles Browser profiles
trash Profiles waiting in the trash (restore with `ant0
profiles restore`)
proxies Shared proxy objects
extensions Extension library shared by profiles (unpacked
folders under <home>/extensions)
events [options] Tail the event stream (one JSON object per line;
Ctrl-C to stop)
login [options] [email] Sign in to your Ant0 account on this computer (the
daemon holds the session)
logout Sign this computer out (the licence and cloud
session are forgotten)
account Show the account and licence state of this computer
(GET /v1/licence)
licence Licence of this computer
workspace List and select account workspaces
sync Encrypted profile sync and transfers
team Folders, members and invitations
api-keys Manage delegated API keys using the local master
bearer
key-status Read current delegated key authorization status
mcp Bounded local MCP adapter (inventory reads plus
profile run/stop)
help [command] display help for command

ant0 --json daemon

Usage: ant0 daemon [options] [command]
Run and inspect the local ant0d daemon
Options:
-h, --help display help for command
Commands:
start [options] Start ant0d in the background (or attached with --foreground)
stop Stop the running daemon (SIGTERM, waits up to 10 s)
status Show whether the daemon answers and where
help [command] display help for command

ant0 --json browsers

Usage: ant0 browsers [options] [command]
Installed Ant0 Browser releases
Options:
-h, --help display help for command
Commands:
ls List installed releases
default <version> Make an installed release the one unpinned profiles
launch
available [options] Show the current release of a channel
install [options] Download and verify a release (the channel's current one
by default)
rm <version> Remove an installed release (refused while a profile uses
it)
help [command] display help for command

ant0 --json profiles

Usage: ant0 profiles [options] [command]
Browser profiles
Options:
-h, --help display help for command
Commands:
ls [options] List profiles
create [options] <name> Create a profile
show <id> Show a profile (UUID or exact name) and its runtime
state
edit [options] <id> Patch fields: --set
network.geo.timezone=Europe/Berlin --set tags=a,b
--set pinned=true
set [options] <ref...> Change group, tags or pin on one or more profiles
(POST /profiles/bulk-update); use `edit --set` for
any other field
rm [options] <ref...> Move profiles to the trash (kept for a few days,
`profiles restore` brings them back); --permanent
deletes them for good, data directory included.
Refused while running
restore <ref...> Bring profiles back from the trash
run [options] <id> Run a profile's saved configuration without
requesting a CDP endpoint
start [options] <ref...> Developer launch with CDP details and optional
overrides; several refs use the endpoint-free bulk
run route
stop [options] <ref...> Stop the running browser of one or more profiles
(POST /profiles/bulk-stop)
status <id> Run state and endpoint-free lifecycle metadata of a
profile
promote [options] <id> Publish an inherited local copy independently in the
current workspace
identity <id> Preview the fingerprint persona the profile will
launch with
cookies Import and export cookies
bulk <file> Create profiles from a CSV file (header row + one
profile per row)
help [command] display help for command

ant0 --json trash

Usage: ant0 trash [options] [command]
Profiles waiting in the trash (restore with `ant0 profiles restore`)
Options:
-h, --help display help for command
Commands:
ls [options] List trashed profiles and when each will be purged
empty [options] Permanently delete every trashed profile now (running ones
are skipped)
help [command] display help for command

ant0 --json proxies

Usage: ant0 proxies [options] [command]
Shared proxy objects
Options:
-h, --help display help for command
Commands:
ls [options] List proxies
add [options] <proxy> Add a proxy from scheme://user:pass@host:port or
host:port:user:pass
show <ref> Show one proxy (UUID or exact name)
check <ref> Connect through the proxy and report exit IP, country
and latency
change-ip <ref> Ask the provider for a new exit IP (GETs the proxy's
change_ip_url)
rm <ref> Delete a proxy (refused while a profile references it)
help [command] display help for command

ant0 --json extensions

Usage: ant0 extensions [options] [command]
Extension library shared by profiles (unpacked folders under <home>/extensions)
Options:
-h, --help display help for command
Commands:
ls List library extensions and how many profiles use each
add <path> Add an unpacked extension folder, a .zip or a .crx to the
library
show <id> Show one library extension
rm [options] <id> Remove an extension from the library (refused while a
profile uses it)
help [command] display help for command

ant0 --json licence

Usage: ant0 licence [options] [command]
Licence of this computer
Options:
-h, --help display help for command
Commands:
refresh Ask the Ant0 cloud for a fresh licence now (otherwise hourly)
help [command] display help for command

ant0 --json workspace

Usage: ant0 workspace [options] [command]
List and select account workspaces
Options:
-h, --help display help for command
Commands:
list|ls List workspaces available to the signed-in account
switch <id> Switch this daemon session to another usable workspace
help [command] display help for command

ant0 --json sync

Usage: ant0 sync [options] [command]
Encrypted profile sync and transfers
Options:
-h, --help display help for command
Commands:
status Show local sync, key and profile state
remote Cloud profiles visible to this device
enroll [options] <local> Enroll a stopped local profile in workspace sync
pull <local> Pull the current remote revision without
overwriting dirty state
push <local> Capture a stopped profile and queue an encrypted
upload
disable [options] <local> Stop syncing locally, or permanently delete the
remote profile
conflicts Preserved offline and CAS conflicts
recipients Workspace-key device recipients
keys CLI-only workspace recovery-key operations
transfer Cross-workspace profile transfer
help [command] display help for command

ant0 --json team

Usage: ant0 team [options] [command]
Folders, members and invitations
Options:
-h, --help display help for command
Commands:
folders Team profile folders
members Accepted workspace members
invites Workspace invitations
ownership Workspace ownership transfer
help [command] display help for command

ant0 --json api-keys

Usage: ant0 api-keys [options] [command]
Manage delegated API keys using the local master bearer
Options:
-h, --help display help for command
Commands:
create [options] [name] Durably provision or exactly replay a private
credential file
list [options]
show [options] <id>
rename [options] <id> <name>
revoke [options] <id>
help [command] display help for command

ant0 --json mcp

Usage: ant0 mcp [options] [command]
Bounded local MCP adapter (inventory reads plus profile run/stop)
Options:
-h, --help display help for command
Commands:
serve [options] Serve MCP over stdio using an already-running local daemon
help [command] display help for command

ant0 daemon

Usage: ant0 daemon [options] [command]
Run and inspect the local ant0d daemon
Options:
-h, --help display help for command
Commands:
start [options] Start ant0d in the background (or attached with --foreground)
stop Stop the running daemon (SIGTERM, waits up to 10 s)
status Show whether the daemon answers and where
help [command] display help for command

ant0 browsers

Usage: ant0 browsers [options] [command]
Installed Ant0 Browser releases
Options:
-h, --help display help for command
Commands:
ls List installed releases
default <version> Make an installed release the one unpinned profiles
launch
available [options] Show the current release of a channel
install [options] Download and verify a release (the channel's current one
by default)
rm <version> Remove an installed release (refused while a profile uses
it)
help [command] display help for command

ant0 profiles

Usage: ant0 profiles [options] [command]
Browser profiles
Options:
-h, --help display help for command
Commands:
ls [options] List profiles
create [options] <name> Create a profile
show <id> Show a profile (UUID or exact name) and its runtime
state
edit [options] <id> Patch fields: --set
network.geo.timezone=Europe/Berlin --set tags=a,b
--set pinned=true
set [options] <ref...> Change group, tags or pin on one or more profiles
(POST /profiles/bulk-update); use `edit --set` for
any other field
rm [options] <ref...> Move profiles to the trash (kept for a few days,
`profiles restore` brings them back); --permanent
deletes them for good, data directory included.
Refused while running
restore <ref...> Bring profiles back from the trash
run [options] <id> Run a profile's saved configuration without
requesting a CDP endpoint
start [options] <ref...> Developer launch with CDP details and optional
overrides; several refs use the endpoint-free bulk
run route
stop [options] <ref...> Stop the running browser of one or more profiles
(POST /profiles/bulk-stop)
status <id> Run state and endpoint-free lifecycle metadata of a
profile
promote [options] <id> Publish an inherited local copy independently in the
current workspace
identity <id> Preview the fingerprint persona the profile will
launch with
cookies Import and export cookies
bulk <file> Create profiles from a CSV file (header row + one
profile per row)
help [command] display help for command

ant0 profiles cookies

Usage: ant0 profiles cookies [options] [command]
Import and export cookies
Options:
-h, --help display help for command
Commands:
import <id> <file> Import cookies (Cookie-Editor JSON,
Puppeteer/Playwright arrays, or Netscape cookies.txt)
export [options] <id> Export cookies
help [command] display help for command

ant0 trash

Usage: ant0 trash [options] [command]
Profiles waiting in the trash (restore with `ant0 profiles restore`)
Options:
-h, --help display help for command
Commands:
ls [options] List trashed profiles and when each will be purged
empty [options] Permanently delete every trashed profile now (running ones
are skipped)
help [command] display help for command

ant0 proxies

Usage: ant0 proxies [options] [command]
Shared proxy objects
Options:
-h, --help display help for command
Commands:
ls [options] List proxies
add [options] <proxy> Add a proxy from scheme://user:pass@host:port or
host:port:user:pass
show <ref> Show one proxy (UUID or exact name)
check <ref> Connect through the proxy and report exit IP, country
and latency
change-ip <ref> Ask the provider for a new exit IP (GETs the proxy's
change_ip_url)
rm <ref> Delete a proxy (refused while a profile references it)
help [command] display help for command

ant0 extensions

Usage: ant0 extensions [options] [command]
Extension library shared by profiles (unpacked folders under <home>/extensions)
Options:
-h, --help display help for command
Commands:
ls List library extensions and how many profiles use each
add <path> Add an unpacked extension folder, a .zip or a .crx to the
library
show <id> Show one library extension
rm [options] <id> Remove an extension from the library (refused while a
profile uses it)
help [command] display help for command

ant0 events

Usage: ant0 events [options]
Tail the event stream (one JSON object per line; Ctrl-C to stop)
Options:
--since <iso-date> replay buffered events at or after this time
--replay <n> how many buffered events to replay first (default 50)
-h, --help display help for command

ant0 login

Usage: ant0 login [options] [email]
Sign in to your Ant0 account on this computer (the daemon holds the session)
Arguments:
email account email (asked for on a terminal when omitted)
Options:
--totp <code> 6-digit authenticator code or a recovery code (2FA accounts)
--password-stdin read the password from stdin instead of the terminal
-h, --help display help for command

ant0 logout

Usage: ant0 logout [options]
Sign this computer out (the licence and cloud session are forgotten)
Options:
-h, --help display help for command

ant0 account

Usage: ant0 account [options]
Show the account and licence state of this computer (GET /v1/licence)
Options:
-h, --help display help for command

ant0 licence

Usage: ant0 licence [options] [command]
Licence of this computer
Options:
-h, --help display help for command
Commands:
refresh Ask the Ant0 cloud for a fresh licence now (otherwise hourly)
help [command] display help for command

ant0 workspace

Usage: ant0 workspace [options] [command]
List and select account workspaces
Options:
-h, --help display help for command
Commands:
list|ls List workspaces available to the signed-in account
switch <id> Switch this daemon session to another usable workspace
help [command] display help for command

ant0 sync

Usage: ant0 sync [options] [command]
Encrypted profile sync and transfers
Options:
-h, --help display help for command
Commands:
status Show local sync, key and profile state
remote Cloud profiles visible to this device
enroll [options] <local> Enroll a stopped local profile in workspace sync
pull <local> Pull the current remote revision without
overwriting dirty state
push <local> Capture a stopped profile and queue an encrypted
upload
disable [options] <local> Stop syncing locally, or permanently delete the
remote profile
conflicts Preserved offline and CAS conflicts
recipients Workspace-key device recipients
keys CLI-only workspace recovery-key operations
transfer Cross-workspace profile transfer
help [command] display help for command

ant0 sync remote

Usage: ant0 sync remote [options] [command]
Cloud profiles visible to this device
Options:
-h, --help display help for command
Commands:
list|ls [options] List remote profiles
materialize [options] <profile> Download a cloud-only profile into a new
local profile
help [command] display help for command

ant0 sync conflicts

Usage: ant0 sync conflicts [options] [command]
Preserved offline and CAS conflicts
Options:
-h, --help display help for command
Commands:
list|ls [options] List unresolved local conflict copies
resolve [options] <local> <action> Resolve with rebase, keep_both or discard
help [command] display help for command

ant0 sync recipients

Usage: ant0 sync recipients [options] [command]
Workspace-key device recipients
Options:
-h, --help display help for command
Commands:
list|ls [options] List devices and key enrollment state
enroll <device> Seal all readable workspace keys to a pending device
confirm Unwrap and confirm this device's pending key envelopes
help [command] display help for command

ant0 sync keys

Usage: ant0 sync keys [options] [command]
CLI-only workspace recovery-key operations
Options:
-h, --help display help for command
Commands:
setup Set up sync keys with a securely pre-saved recovery code
recover Recover sync keys using a securely pre-saved replacement code
lock Zeroize and lock workspace keys held by the daemon
help [command] display help for command

ant0 sync transfer

Usage: ant0 sync transfer [options] [command]
Cross-workspace profile transfer
Options:
-h, --help display help for command
Commands:
list|ls [options] List authorized cross-workspace profile transfers
start [options] <local> <workspace> <name> Start an encrypted transfer of a local synced profile
status <transfer> Show durable profile-transfer state
accept [options] <transfer> Move a ready profile into its destination workspace
abort [options] <transfer> Abort a pending or ready profile transfer
help [command] display help for command

ant0 team

Usage: ant0 team [options] [command]
Folders, members and invitations
Options:
-h, --help display help for command
Commands:
folders Team profile folders
members Accepted workspace members
invites Workspace invitations
ownership Workspace ownership transfer
help [command] display help for command

ant0 team folders

Usage: ant0 team folders [options] [command]
Team profile folders
Options:
-h, --help display help for command
Commands:
list|ls [options] List visible team folders
create [options] <name> Create a team folder
update [options] <id> <name> Rename a team folder with metadata CAS
remove [options] <id> Delete a folder and optionally move its profiles
help [command] display help for command

ant0 team members

Usage: ant0 team members [options] [command]
Accepted workspace members
Options:
-h, --help display help for command
Commands:
list|ls [options] List team members
update [options] <id> Change a member role and folder grants
remove [options] <id> Remove a member and immediately revoke new access
help [command] display help for command

ant0 team invites

Usage: ant0 team invites [options] [command]
Workspace invitations
Options:
-h, --help display help for command
Commands:
list|ls [options] List invitations (tokens are never returned)
create [options] <email> Invite a verified account to the workspace
revoke [options] <id> Revoke a pending invitation
accept [options] Accept an invitation; reads its token without echo
from an interactive terminal
help [command] display help for command

ant0 team ownership

Usage: ant0 team ownership [options] [command]
Workspace ownership transfer
Options:
-h, --help display help for command
Commands:
outgoing [options] List outgoing ownership transfers
incoming [options] List incoming ownership transfers
start [options] <user> Offer workspace ownership to an accepted key-ready
member
accept Accept ownership and show its recovery code on the
controlling terminal
status Retrieve a retained recovery code using the emailed
token
acknowledge [options] Clear a retained recovery code after storing it safely
cancel [options] <id> Cancel a pending ownership transfer
help [command] display help for command

ant0 api-keys

Usage: ant0 api-keys [options] [command]
Manage delegated API keys using the local master bearer
Options:
-h, --help display help for command
Commands:
create [options] [name] Durably provision or exactly replay a private
credential file
list [options]
show [options] <id>
rename [options] <id> <name>
revoke [options] <id>
help [command] display help for command

ant0 key-status

Usage: ant0 key-status [options]
Read current delegated key authorization status
Options:
-h, --help display help for command

ant0 mcp

Usage: ant0 mcp [options] [command]
Bounded local MCP adapter (inventory reads plus profile run/stop)
Options:
-h, --help display help for command
Commands:
serve [options] Serve MCP over stdio using an already-running local daemon
help [command] display help for command