Cypher

Cypher - An AI computer framework


Introduction

Cypher is a flexible and modular framework for building AI agents that access the world via a computer interface. This allows agents to operate continuously and autonomously (via `TerminalCore`), running commands and interacting with a terminal environment.

Cypher focuses on being a native bitcoin framework, allowing agents to freely interact with the Bitcoin blockchain and ecosystem on-chain.

Agents are defined through YAML files rather than hard-coded configurations, making it easy to swap in your own agent definitions, tools, personalities, and features.

QUICK START

1. To test built in implementations, add an anthropic ENV key
2. Run npm run test and pick a test via CLI to play with the system
3. To see agent terminal logs, open localhost:3000 in browser

TERMINAL

Access the terminal during runs with localhost:3000

Agent Configuration & Loading

Loading Agents

There are two main ways to load agent configurations:

Option 1: Direct Config Path

Specify the exact path to your agent's YAML config file:

import { Agent } from 'cypher-core';

const myAgent = new Agent({ 
  agentConfigPath: './my_agents/mySpecialAgent.yaml' 
});
const result = await myAgent.run("Hello");

Option 2: Load by Agent Name

Load an agent by name, which will search in your local agents directory and fall back to built-in agents:

import { Agent } from 'cypher-core';

const myAgent = new Agent({ agentName: "MyAgent" });
const result = await myAgent.run("Hello");

**Built-in Fallbacks**: When using `agentName: "TerminalAgent"` or `agentName: "ChatAgent"`, Cypher Core will automatically use the built-in configurations if