Skip to content

CLI

Anthracode CLI options and commands.

The Anthracode CLI by default starts the TUI when run without any arguments.

Terminal window
anthracode

But it also accepts commands as documented on this page. This allows you to interact with Anthracode programmatically.

Terminal window
anthracode run "Explain how closures work in JavaScript"

Start the Anthracode terminal user interface.

Terminal window
anthracode [project]
FlagShortDescription
--continue-cContinue the last session
--session-sSession ID to continue
--forkFork the session when continuing (use with --continue or --session)
--promptPrompt to use
--model-mModel to use in the form of provider/model
--agentAgent to use
--portPort to listen on
--hostnameHostname to listen on
--mdnsEnable mDNS discovery
--mdns-domainCustom mDNS domain name
--corsAdditional browser origin(s) to allow CORS

The Anthracode CLI also has the following commands.


Manage agents for Anthracode.

Terminal window
anthracode agent [command]

Attach a terminal to an already running Anthracode backend server started via serve.

Terminal window
anthracode attach [url]

This allows using the TUI with a remote Anthracode backend. For example:

Terminal window
# Start the backend server
anthracode serve --port 4096 --hostname 0.0.0.0
# In another terminal, attach the TUI to the running backend
anthracode attach http://10.20.30.40:4096
FlagShortDescription
--dirWorking directory to start TUI in
--continue-cContinue the last session
--session-sSession ID to continue
--forkFork the session when continuing (use with --continue or --session)
--password-pBasic auth password (defaults to ANTHRACODE_SERVER_PASSWORD)
--username-uBasic auth username (defaults to ANTHRACODE_SERVER_USERNAME or anthracode)

Create a new agent with custom configuration.

Terminal window
anthracode agent create

This command will guide you through creating a new agent with a custom system prompt and permission configuration. Anything you don’t allow is denied in the generated agent’s frontmatter.

FlagShortDescription
--pathDirectory to write the agent file to (defaults to global or .anthracode/agent based on the prompt)
--descriptionWhat the agent should do
--modeAgent mode: all, primary, or subagent
--permissionsComma-separated list of permissions to allow (default: all). Available: bash, read, edit, glob, grep, webfetch, task, todowrite, websearch, lsp, skill. Anything omitted is denied. Alias: --tools
--model-mModel to use, in provider/model format

Passing all of --path, --description, --mode, and --permissions runs the command non-interactively.


List all available agents.

Terminal window
anthracode agent list

Command to manage credentials and login for providers.

Terminal window
anthracode auth [command]

Anthracode is powered by the provider list at Models.dev, so you can use anthracode auth login to configure API keys for any provider you’d like to use. This is stored in ~/.local/share/anthracode/auth.json.

Terminal window
anthracode auth login

When Anthracode starts up it loads the providers from the credentials file. And if there are any keys defined in your environments or a .env file in your project.

FlagShortDescription
--provider-pProvider ID or name to log in to
--method-mLogin method label to use, skipping method selection

Lists all the authenticated providers as stored in the credentials file.

Terminal window
anthracode auth list

Or the short version.

Terminal window
anthracode auth ls

Logs you out of a provider by clearing it from the credentials file.

Terminal window
anthracode auth logout

Manage the GitHub agent for repository automation.

Terminal window
anthracode github [command]

Install the GitHub agent in your repository.

Terminal window
anthracode github install

This sets up the necessary GitHub Actions workflow and guides you through the configuration process. Learn more.


Run the GitHub agent. This is typically used in GitHub Actions.

Terminal window
anthracode github run
FlagDescription
--eventGitHub mock event to run the agent for
--tokenGitHub personal access token

Manage Model Context Protocol servers.

Terminal window
anthracode mcp [command]

Add an MCP server to your configuration.

Terminal window
anthracode mcp add

This command will guide you through adding either a local or remote MCP server.


List all configured MCP servers and their connection status.

Terminal window
anthracode mcp list

Or use the short version.

Terminal window
anthracode mcp ls

Authenticate with an OAuth-enabled MCP server.

Terminal window
anthracode mcp auth [name]

If you don’t provide a server name, you’ll be prompted to select from available OAuth-capable servers.

You can also list OAuth-capable servers and their authentication status.

Terminal window
anthracode mcp auth list

Or use the short version.

Terminal window
anthracode mcp auth ls

Remove OAuth credentials for an MCP server.

Terminal window
anthracode mcp logout [name]

Debug OAuth connection issues for an MCP server.

Terminal window
anthracode mcp debug <name>

List all available models from configured providers.

Terminal window
anthracode models [provider]

This command displays all models available across your configured providers in the format provider/model.

This is useful for figuring out the exact model name to use in your config.

You can optionally pass a provider ID to filter models by that provider.

Terminal window
anthracode models anthropic
FlagDescription
--refreshRefresh the models cache from models.dev
--verboseUse more verbose model output (includes metadata like costs)

Use the --refresh flag to update the cached model list. This is useful when new models have been added to a provider and you want to see them in Anthracode.

Terminal window
anthracode models --refresh

Run anthracode in non-interactive mode by passing a prompt directly.

Terminal window
anthracode run [message..]

This is useful for scripting, automation, or when you want a quick answer without launching the full TUI. For example.

Terminal window
anthracode run Explain the use of context in Go

You can also attach to a running anthracode serve instance to avoid MCP server cold boot times on every run:

Terminal window
# Start a headless server in one terminal
anthracode serve
# In another terminal, run commands that attach to it
anthracode run --attach http://localhost:4096 "Explain async/await in JavaScript"
FlagShortDescription
--commandThe command to run, use message for args
--continue-cContinue the last session
--session-sSession ID to continue
--forkFork the session when continuing (use with --continue or --session)
--model-mModel to use in the form of provider/model
--agentAgent to use
--file-fFile(s) to attach to message
--formatFormat: default (formatted) or json (raw JSON events)
--titleTitle for the session (uses truncated prompt if no value provided)
--attachAttach to a running anthracode server (e.g., http://localhost:4096)
--password-pBasic auth password (defaults to ANTHRACODE_SERVER_PASSWORD)
--username-uBasic auth username (defaults to ANTHRACODE_SERVER_USERNAME or anthracode)
--dirDirectory to run in, or path on the remote server when attaching
--portPort for the local server (defaults to random port)
--variantModel variant (provider-specific reasoning effort)
--thinkingShow thinking blocks
--dangerously-skip-permissionsAuto-approve permissions that are not explicitly denied (dangerous!)

Start a headless Anthracode server for API access. Check out the server docs for the full HTTP interface.

Terminal window
anthracode serve

This starts an HTTP server that provides API access to anthracode functionality without the TUI interface. Set ANTHRACODE_SERVER_PASSWORD to enable HTTP basic auth (username defaults to anthracode).

FlagDescription
--portPort to listen on
--hostnameHostname to listen on
--mdnsEnable mDNS discovery
--mdns-domainCustom mDNS domain name
--corsAdditional browser origin(s) to allow CORS

Manage Anthracode sessions.

Terminal window
anthracode session [command]

List all Anthracode sessions.

Terminal window
anthracode session list
FlagShortDescription
--max-count-nLimit to N most recent sessions
--formatOutput format: table or json (table)

Delete an Anthracode session.

Terminal window
anthracode session delete <sessionID>

Show token usage and cost statistics for your Anthracode sessions.

Terminal window
anthracode stats
FlagDescription
--daysShow stats for the last N days (all time)
--toolsNumber of tools to show (all)
--modelsShow model usage breakdown (hidden by default). Pass a number to show top N
--projectFilter by project (all projects, empty string: current project)

Export session data as JSON.

Terminal window
anthracode export [sessionID]

If you don’t provide a session ID, you’ll be prompted to select from available sessions.

FlagDescription
--sanitizeRedact sensitive transcript/file data

Import session data from a JSON file.

Terminal window
anthracode import <file>

You can import from a local file.

Terminal window
anthracode import session.json

Start an ACP (Agent Client Protocol) server.

Terminal window
anthracode acp

This command starts an ACP server that communicates via stdin/stdout using nd-JSON.

FlagDescription
--cwdWorking directory
--portPort to listen on
--hostnameHostname to listen on
--mdnsEnable mDNS discovery
--mdns-domainCustom mDNS domain name
--corsAdditional browser origin(s) to allow CORS

Install a plugin and update your config.

Terminal window
anthracode plugin <module>

Or use the alias.

Terminal window
anthracode plug <module>
FlagShortDescription
--global-gInstall in global config
--force-fReplace existing plugin version

Fetch and checkout a GitHub PR branch, then run Anthracode.

Terminal window
anthracode pr <number>

Database tools.

Terminal window
anthracode db [query]
FlagDescription
--formatOutput format: json or tsv

Print the database path.

Terminal window
anthracode db path

Debugging and troubleshooting tools.

Terminal window
anthracode debug [command]

Uninstall Anthracode and remove all related files.

Terminal window
anthracode uninstall
FlagShortDescription
--keep-config-cKeep configuration files
--keep-data-dKeep session data and snapshots
--dry-runShow what would be removed without removing
--force-fSkip confirmation prompts

Updates anthracode to the latest version or a specific version.

Terminal window
anthracode upgrade [target]

To upgrade to the latest version.

Terminal window
anthracode upgrade

To upgrade to a specific version.

Terminal window
anthracode upgrade v0.1.48
FlagShortDescription
--method-mThe installation method that was used; curl, npm, pnpm, bun, brew

The anthracode CLI takes the following global flags.

FlagShortDescription
--help-hDisplay help
--version-vPrint version number
--print-logsPrint logs to stderr
--log-levelLog level (DEBUG, INFO, WARN, ERROR)
--pureRun without external plugins

Anthracode can be configured using environment variables.

VariableTypeDescription
ANTHRACODE_GIT_BASH_PATHstringPath to Git Bash executable on Windows
ANTHRACODE_CONFIGstringPath to config file
ANTHRACODE_TUI_CONFIGstringPath to TUI config file
ANTHRACODE_CONFIG_DIRstringPath to config directory
ANTHRACODE_CONFIG_CONTENTstringInline json config content
ANTHRACODE_DISABLE_AUTOUPDATEbooleanDisable automatic update checks
ANTHRACODE_DISABLE_PRUNEbooleanDisable pruning of old data
ANTHRACODE_DISABLE_TERMINAL_TITLEbooleanDisable automatic terminal title updates
ANTHRACODE_PERMISSIONstringInlined json permissions config
ANTHRACODE_DISABLE_DEFAULT_PLUGINSbooleanDisable default plugins
ANTHRACODE_DISABLE_LSP_DOWNLOADbooleanDisable automatic LSP server downloads
ANTHRACODE_ENABLE_EXPERIMENTAL_MODELSbooleanEnable experimental models
ANTHRACODE_DISABLE_AUTOCOMPACTbooleanDisable automatic context compaction
ANTHRACODE_DISABLE_CLAUDE_CODEbooleanDisable reading from .claude (prompt + skills)
ANTHRACODE_DISABLE_CLAUDE_CODE_PROMPTbooleanDisable reading ~/.claude/CLAUDE.md
ANTHRACODE_DISABLE_CLAUDE_CODE_SKILLSbooleanDisable loading .claude/skills
ANTHRACODE_DISABLE_MODELS_FETCHbooleanDisable fetching models from remote sources
ANTHRACODE_DISABLE_MOUSEbooleanDisable mouse capture in the TUI
ANTHRACODE_FAKE_VCSstringFake VCS provider for testing purposes
ANTHRACODE_CLIENTstringClient identifier (defaults to cli)
ANTHRACODE_ENABLE_EXAbooleanEnable Exa web search tools
ANTHRACODE_SERVER_PASSWORDstringEnable basic auth for serve
ANTHRACODE_SERVER_USERNAMEstringOverride basic auth username (default anthracode)
ANTHRACODE_MODELS_URLstringCustom URL for fetching models configuration

These environment variables enable experimental features that may change or be removed.

VariableTypeDescription
ANTHRACODE_EXPERIMENTALbooleanEnable all experimental features
ANTHRACODE_EXPERIMENTAL_ICON_DISCOVERYbooleanEnable icon discovery
ANTHRACODE_EXPERIMENTAL_DISABLE_COPY_ON_SELECTbooleanDisable copy on select in TUI
ANTHRACODE_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MSnumberDefault timeout for bash commands in ms
ANTHRACODE_EXPERIMENTAL_OUTPUT_TOKEN_MAXnumberMax output tokens for LLM responses
ANTHRACODE_EXPERIMENTAL_FILEWATCHERbooleanEnable file watcher for entire dir
ANTHRACODE_EXPERIMENTAL_OXFMTbooleanEnable oxfmt formatter
ANTHRACODE_EXPERIMENTAL_LSP_TOOLbooleanEnable experimental LSP tool
ANTHRACODE_EXPERIMENTAL_DISABLE_FILEWATCHERbooleanDisable file watcher
ANTHRACODE_EXPERIMENTAL_EXAbooleanEnable experimental Exa features
ANTHRACODE_EXPERIMENTAL_LSP_TYbooleanEnable TY LSP for python files
ANTHRACODE_EXPERIMENTAL_MARKDOWNbooleanEnable experimental markdown features
ANTHRACODE_EXPERIMENTAL_PLAN_MODEbooleanEnable plan mode