Skip to content

CLI Overview

Ash CLI command surface (uv run ash --help):

Usage

Terminal window
uv run ash [OPTIONS] COMMAND [ARGS]...

Top-Level Commands

CommandDescription
authOAuth authentication
chatInteractive chat or single prompt
configConfiguration management
doctorRead-only operational checks
graphGraph inspection utilities
initCreate starter configuration
logsView/search logs
memoryMemory management
peoplePerson record management
sandboxSandbox management
scheduleScheduled task management
serveStart server
serviceBackground service management
sessionsSession inspection/debugging
skillSkill management
statsOperational stats
upgradeUpgrade checks/build

Key Environment Variables

VariableDescription
ASH_HOMEBase state directory (config.toml, logs, sessions, auth)
OPENAI_API_KEYOpenAI API key
ANTHROPIC_API_KEYAnthropic API key
TELEGRAM_BOT_TOKENTelegram bot token
BRAVE_SEARCH_API_KEYBrave Search API key
SENTRY_DSNSentry DSN

Bootstrap Sequence

Terminal window
uv run ash init
uv run ash auth login
uv run ash config validate
uv run ash upgrade
uv run ash chat

Need to remove Ash later? See Uninstall.