CLI

ArmIn CLI options and commands.

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

armin

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

armin run "Explain how closures work in JavaScript"

tui

Start the ArmIn terminal user interface.

armin [project]

Flags

Flag	Short	Description
`--continue`	`-c`	Continue the last session
`--session`	`-s`	Session ID to continue
`--fork`		Fork the session when continuing (use with `--continue` or `--session`)
`--prompt`		Prompt to use
`--model`	`-m`	Model to use in the form of provider/model
`--agent`		Agent to use
`--port`		Port to listen on
`--hostname`		Hostname to listen on

Commands

The ArmIn CLI also has the following commands.

agent

Manage agents for ArmIn.

armin agent [command]

attach

Attach a terminal to an already running ArmIn backend server started via serve or web commands.

armin attach [url]

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

# Start the backend server for web/mobile access
armin web --port 4096 --hostname 0.0.0.0

# In another terminal, attach the TUI to the running backend
armin attach http://10.20.30.40:4096

Flags

Flag	Short	Description
`--dir`		Working directory to start TUI in
`--session`	`-s`	Session ID to continue

create

Create a new agent with custom configuration.

armin agent create

This command will guide you through creating a new agent with a custom system prompt and tool configuration.

list

List all available agents.

armin agent list

auth

Command to manage credentials and login for providers.

armin auth [command]

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

armin auth login

When ArmIn 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.

list

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

armin auth list

Or the short version.

armin auth ls

logout

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

armin auth logout

github

Manage the GitHub agent for repository automation.

armin github [command]

install

Install the GitHub agent in your repository.

armin github install

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

run

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

armin github run

Flags

Flag	Description
`--event`	GitHub mock event to run the agent for
`--token`	GitHub personal access token

mcp

Manage Model Context Protocol servers.

armin mcp [command]

add

Add an MCP server to your configuration.

armin mcp add

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

list

List all configured MCP servers and their connection status.

armin mcp list

Or use the short version.

armin mcp ls

auth

Authenticate with an OAuth-enabled MCP server.

armin 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.

armin mcp auth list

Or use the short version.

armin mcp auth ls

logout

Remove OAuth credentials for an MCP server.

armin mcp logout [name]

debug

Debug OAuth connection issues for an MCP server.

armin mcp debug <name>

models

List all available models from configured providers.

armin 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.

armin models anthropic

Flags

Flag	Description
`--refresh`	Refresh the models cache from models.dev
`--verbose`	Use 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 ArmIn.

armin models --refresh

run

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

armin run [message..]

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

armin run Explain the use of context in Go

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

# Start a headless server in one terminal
armin serve

# In another terminal, run commands that attach to it
armin run --attach http://localhost:4096 "Explain async/await in JavaScript"

Flags

Flag	Short	Description
`--command`		The command to run, use message for args
`--continue`	`-c`	Continue the last session
`--session`	`-s`	Session ID to continue
`--fork`		Fork the session when continuing (use with `--continue` or `--session`)
`--share`		Share the session
`--model`	`-m`	Model to use in the form of provider/model
`--agent`		Agent to use
`--file`	`-f`	File(s) to attach to message
`--format`		Format: default (formatted) or json (raw JSON events)
`--title`		Title for the session (uses truncated prompt if no value provided)
`--attach`		Attach to a running armin server (e.g., http://localhost:4096)
`--port`		Port for the local server (defaults to random port)

serve

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

armin serve

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

Flags

Flag	Description
`--port`	Port to listen on
`--hostname`	Hostname to listen on
`--mdns`	Enable mDNS discovery
`--cors`	Additional browser origin(s) to allow CORS

session

Manage ArmIn sessions.

armin session [command]

list

List all ArmIn sessions.

armin session list

Flags

Flag	Short	Description
`--max-count`	`-n`	Limit to N most recent sessions
`--format`		Output format: table or json (table)

stats

Show token usage and cost statistics for your ArmIn sessions.

armin stats

Flags

Flag	Description
`--days`	Show stats for the last N days (all time)
`--tools`	Number of tools to show (all)
`--models`	Show model usage breakdown (hidden by default). Pass a number to show top N
`--project`	Filter by project (all projects, empty string: current project)

export

Export session data as JSON.

armin export [sessionID]

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

import

Import session data from a JSON file or ArmIn share URL.

armin import <file>

You can import from a local file or an ArmIn share URL.

armin import session.json
armin import https://opncd.ai/s/abc123

web

Start a headless ArmIn server with a web interface.

armin web

This starts an HTTP server and opens a web browser to access ArmIn through a web interface. Set OPENCODE_SERVER_PASSWORD to enable HTTP basic auth (username defaults to armin).

Flags

Flag	Description
`--port`	Port to listen on
`--hostname`	Hostname to listen on
`--mdns`	Enable mDNS discovery
`--cors`	Additional browser origin(s) to allow CORS

acp

Start an ACP (Agent Client Protocol) server.

armin acp

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

Flags

Flag	Description
`--cwd`	Working directory
`--port`	Port to listen on
`--hostname`	Hostname to listen on

uninstall

Uninstall ArmIn and remove all related files.

armin uninstall

Flags

Flag	Short	Description
`--keep-config`	`-c`	Keep configuration files
`--keep-data`	`-d`	Keep session data and snapshots
`--dry-run`		Show what would be removed without removing
`--force`	`-f`	Skip confirmation prompts

upgrade

Updates armin to the latest version or a specific version.

armin upgrade [target]

To upgrade to the latest version.

armin upgrade

To upgrade to a specific version.

armin upgrade v0.1.48

Flags

Flag	Short	Description
`--method`	`-m`	The installation method that was used; curl, npm, pnpm, bun, brew

Global Flags

The armin CLI takes the following global flags.

Flag	Short	Description
`--help`	`-h`	Display help
`--version`	`-v`	Print version number
`--print-logs`		Print logs to stderr
`--log-level`		Log level (DEBUG, INFO, WARN, ERROR)

Environment variables

ArmIn can be configured using environment variables.

Variable	Type	Description
`OPENCODE_AUTO_SHARE`	boolean	Automatically share sessions
`OPENCODE_GIT_BASH_PATH`	string	Path to Git Bash executable on Windows
`OPENCODE_CONFIG`	string	Path to config file
`OPENCODE_TUI_CONFIG`	string	Path to TUI config file
`OPENCODE_CONFIG_DIR`	string	Path to config directory
`OPENCODE_CONFIG_CONTENT`	string	Inline json config content
`OPENCODE_DISABLE_AUTOUPDATE`	boolean	Disable automatic update checks
`OPENCODE_DISABLE_PRUNE`	boolean	Disable pruning of old data
`OPENCODE_DISABLE_TERMINAL_TITLE`	boolean	Disable automatic terminal title updates
`OPENCODE_PERMISSION`	string	Inlined json permissions config
`OPENCODE_DISABLE_DEFAULT_PLUGINS`	boolean	Disable default plugins
`OPENCODE_DISABLE_LSP_DOWNLOAD`	boolean	Disable automatic LSP server downloads
`OPENCODE_ENABLE_EXPERIMENTAL_MODELS`	boolean	Enable experimental models
`OPENCODE_DISABLE_AUTOCOMPACT`	boolean	Disable automatic context compaction
`OPENCODE_DISABLE_CLAUDE_CODE`	boolean	Disable reading from `.claude` (prompt + skills)
`OPENCODE_DISABLE_CLAUDE_CODE_PROMPT`	boolean	Disable reading `~/.claude/CLAUDE.md`
`OPENCODE_DISABLE_CLAUDE_CODE_SKILLS`	boolean	Disable loading `.claude/skills`
`OPENCODE_DISABLE_MODELS_FETCH`	boolean	Disable fetching models from remote sources
`OPENCODE_DISABLE_MOUSE`	boolean	Disable mouse capture in the TUI
`OPENCODE_FAKE_VCS`	string	Fake VCS provider for testing purposes
`OPENCODE_DISABLE_FILETIME_CHECK`	boolean	Disable file time checking for optimization
`OPENCODE_CLIENT`	string	Client identifier (defaults to `cli`)
`OPENCODE_ENABLE_EXA`	boolean	Enable Exa web search tools
`OPENCODE_SERVER_PASSWORD`	string	Enable basic auth for `serve`/`web`
`OPENCODE_SERVER_USERNAME`	string	Override basic auth username (default `armin`)
`OPENCODE_MODELS_URL`	string	Custom URL for fetching models configuration

Experimental

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

Variable	Type	Description
`OPENCODE_EXPERIMENTAL`	boolean	Enable all experimental features
`OPENCODE_EXPERIMENTAL_ICON_DISCOVERY`	boolean	Enable icon discovery
`OPENCODE_EXPERIMENTAL_DISABLE_COPY_ON_SELECT`	boolean	Disable copy on select in TUI
`OPENCODE_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MS`	number	Default timeout for bash commands in ms
`OPENCODE_EXPERIMENTAL_OUTPUT_TOKEN_MAX`	number	Max output tokens for LLM responses
`OPENCODE_EXPERIMENTAL_FILEWATCHER`	boolean	Enable file watcher for entire dir
`OPENCODE_EXPERIMENTAL_OXFMT`	boolean	Enable oxfmt formatter
`OPENCODE_EXPERIMENTAL_LSP_TOOL`	boolean	Enable experimental LSP tool
`OPENCODE_EXPERIMENTAL_DISABLE_FILEWATCHER`	boolean	Disable file watcher
`OPENCODE_EXPERIMENTAL_EXA`	boolean	Enable experimental Exa features
`OPENCODE_EXPERIMENTAL_LSP_TY`	boolean	Enable TY LSP for python files
`OPENCODE_EXPERIMENTAL_MARKDOWN`	boolean	Enable experimental markdown features
`OPENCODE_EXPERIMENTAL_PLAN_MODE`	boolean	Enable plan mode