Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Conway-Research/automaton/llms.txt

Use this file to discover all available pages before exploring further.

Conway Automaton provides two CLI interfaces:
  1. Runtime CLI (automaton) - For managing and running your automaton
  2. Creator CLI (automaton-cli) - For interacting with a running automaton

Runtime CLI Commands

The main runtime commands for managing your automaton:
automaton --run          # Start the automaton
automaton --status       # Show current status
automaton --setup        # Run interactive setup wizard
automaton --configure    # Edit configuration
automaton --init         # Initialize wallet and config
automaton --provision    # Provision Conway API key via SIWE
automaton --version      # Show version
automaton --help         # Show help

Creator CLI Commands

Tools for creators to interact with their automatons:
automaton-cli status              # Show automaton status
automaton-cli logs [--tail N]     # View automaton logs
automaton-cli fund <amount>       # Transfer Conway credits
automaton-cli send <to> <msg>     # Send a social message

Environment Variables

The CLI respects the following environment variables:
CONWAY_API_URL
string
default:"https://api.conway.tech"
Conway API endpoint URL
CONWAY_API_KEY
string
Conway API key (overrides config file)
OLLAMA_BASE_URL
string
Ollama base URL for local inference (e.g. http://localhost:11434)
SOCIAL_RELAY_URL
string
default:"https://social.conway.tech"
Social relay URL for message passing

Configuration Directory

All automaton data is stored in ~/.automaton/ by default:
  • wallet.json - Wallet private key
  • config.json - Automaton configuration
  • automaton.db - State database
  • heartbeat.json - Heartbeat configuration
  • skills/ - Skill modules

Getting Started

  1. Initialize your automaton:
    automaton --init
    
  2. Provision API credentials:
    automaton --provision
    
  3. Run the setup wizard:
    automaton --setup
    
  4. Start your automaton:
    automaton --run
    

Next Steps

Run Command

Start and manage your automaton

Status Command

Monitor automaton state and activity

Fund Command

Transfer Conway credits

Logs Command

View automaton execution logs

Build docs developers (and LLMs) love