Skip to content

CLI Overview

Ash provides a comprehensive CLI for interacting with your assistant.

Usage

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

Global Options

OptionDescription
--helpShow help message
--versionShow version

Commands

CommandDescription
initInitialize configuration file
chatInteractive chat or single prompt
serveStart the server
configConfiguration management
memoryMemory management
sessionsSession management
scheduleScheduled task management
skillSkill management
sandboxSandbox management
dbDatabase operations
upgradeRun migrations and checks
serviceService management

Getting Help

Get help for any command:

Terminal window
uv run ash --help
uv run ash chat --help
uv run ash memory --help

Environment Variables

VariableDescription
ASH_CONFIGConfig file path
ANTHROPIC_API_KEYAnthropic API key
OPENAI_API_KEYOpenAI API key
TELEGRAM_BOT_TOKENTelegram bot token
BRAVE_SEARCH_API_KEYBrave Search API key
SENTRY_DSNSentry DSN

Quick Start

  1. Initialize configuration:

    Terminal window
    uv run ash init
  2. Add your API keys to ~/.ash/config.toml

  3. Run setup tasks:

    Terminal window
    uv run ash upgrade
  4. Start chatting:

    Terminal window
    uv run ash chat

Running as a Service

For persistent operation with Telegram:

Terminal window
# Install as system service
uv run ash service install
# Start the service
uv run ash service start
# View logs
uv run ash service logs

See service for details.