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.

​
Prerequisites

Before installing Conway Automaton, ensure your system meets these requirements:
  • Node.js: Version 20.0.0 or higher
  • Package Manager: npm, pnpm (recommended), or yarn
  • Operating System: Linux, macOS, or Windows with WSL2
  • Git: For cloning the repository
Conway Automaton uses pnpm@10.28.1 as its package manager. While npm and yarn work, pnpm is recommended for optimal performance.

​
Verify Node.js Version

Check your Node.js version: 
node --version
If you need to install or upgrade Node.js, visit nodejs.org or use a version manager like nvm: 
nvm install 20
nvm use 20

​
Installation Methods

The fastest way to get started with Conway Automaton is using the automated installer: 
curl -fsSL https://conway.tech/automaton.sh | sh
This script will:
  • Clone the repository
  • Install dependencies
  • Build the project
  • Launch the interactive setup wizard
Always review scripts before running them with curl | sh. You can inspect the installer at https://conway.tech/automaton.sh

​
Method 2: Manual Installation

For more control over the installation process, clone and build manually:
1

Clone the repository

git clone https://github.com/Conway-Research/automaton.git
cd automaton
2

Install dependencies

pnpm install
3

Build the project

pnpm build
4

Verify installation

node dist/index.js --version
You should see output like:
Conway Automaton v0.2.1

​
Method 3: Global Installation

Install Conway Automaton globally via npm: 
pnpm add -g @conway/automaton
After global installation, you can run the automaton from anywhere: 
automaton --version

​
Key Dependencies

Conway Automaton relies on several core libraries:
  • better-sqlite3: Local state persistence
  • viem: Ethereum wallet and transaction management
  • siwe: Sign-In With Ethereum for API authentication
  • openai: Inference client for OpenAI models
  • chalk and ora: CLI interface enhancements
These are installed automatically during the setup process.

​
Directory Structure

After installation, the automaton creates a configuration directory at ~/.automaton/: 
~/.automaton/
├── wallet.json          # EVM wallet (private key)
├── config.json          # Conway API key
├── automaton.json       # Runtime configuration
├── heartbeat.yml        # Scheduled tasks
├── state.db             # SQLite database
├── constitution.md      # Immutable laws (read-only)
├── SOUL.md              # Self-authored identity
└── skills/              # Installed skills
    ├── conway-compute/
    ├── conway-payments/
    └── survival/
The wallet.json file contains your automaton’s private key. This is its sovereign identity. Keep it secure with chmod 600 permissions (set automatically).

​
Next Steps

With Conway Automaton installed, you’re ready to configure your agent:

Setup Wizard

Run the interactive setup wizard to generate your automaton’s identity and configure its personality

Build docs developers (and LLMs) love

Get started for freeTalk to us