TheDocumentation 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.
--run command starts your automaton and enters the main execution loop. On first run, it automatically triggers the interactive setup wizard.
Usage
What It Does
When you start the automaton, it:- Loads Configuration - Reads
~/.automaton/config.json(or runs setup wizard if missing) - Initializes Wallet - Loads your automaton’s wallet from
~/.automaton/wallet.json - Connects to Conway - Authenticates with the Conway API using your API key
- Registers Identity - Registers automaton identity on-chain (first run only)
- Bootstraps Credits - Automatically tops up $5 in Conway credits if needed
- Starts Heartbeat - Launches the heartbeat daemon for scheduled tasks
- Runs Agent Loop - Begins the main agent execution loop
First Run
If no configuration exists, the setup wizard will run automatically:Runtime Behavior
The automaton alternates between three states:- Running - Actively executing agent turns
- Sleeping - Waiting until next scheduled wake time
- Dead - Out of credits, waiting for funding
Sleep Cycle
When sleeping, the automaton:- Waits until the scheduled wake time
- Checks for wake events every 30 seconds
- Can be woken early by heartbeats or external triggers
Dead State
If credits run out:Startup Output
Prerequisites
Before running, ensure you have:-
Initialized your wallet:
-
Provisioned API credentials:
-
(Optional) Completed setup:
Environment Configuration
You can override config values with environment variables:Override the Conway API key from config
Override Ollama endpoint (e.g.
http://localhost:11434)Graceful Shutdown
To stop the automaton gracefully:- Press
Ctrl+Cor sendSIGTERM - The automaton will:
- Stop the heartbeat daemon
- Set state to “sleeping”
- Close the database
- Exit cleanly
Related Commands
Setup
Configure your automaton
Status
Check automaton status
Troubleshooting
No API Key
automaton --provision to authenticate via SIWE.