Installation

Prerequisites

• Node.js: v20.x or higher
• npm: v10.x or higher

Clone and install

1. Clone the repository and navigate into the project directory:

   git clone https://github.com/thiagocolen/pinky-and-the-brain.git
   cd pinky-and-the-brain

2. Install dependencies:

   npm install

3. Create a .env file in the root directory (see Configuration for the full list of variables):

   # LLM API Key (Required - Anthropic is the only supported provider)
   ANTHROPIC_API_KEY=your_anthropic_api_key_here
   # ANTHROPIC_MODEL=claude-sonnet-5
   
   # API Gateway security key (Required for server and clients)
   PATBA_API_KEY=your_secret_api_key_here
   
   # Local Storage
   SQLITE_DB_PATH=state.db
   PORT=8080
   
   # AWS Configuration (Optional, falls back to local sqlite/memory offline)
   AWS_REGION=sa-east-1
   S3_BUCKET_NAME=pinky-and-the-brain-agents-state-store
   
   # Optional integrations
   SLACK_BOT_TOKEN=your_slack_bot_token_here

Build the project

Compile TypeScript into JavaScript:

npm run build

The compiled output is emitted to dist/, which is what every npm run <entrypoint> script executes.

Next steps

Once installed and built, jump to one of the entrypoint guides:

• CLI Usage - a local interactive REPL.
• REST/SSE Server Usage - an HTTP API with streaming.
• MCP Usage - a stdio MCP server for MCP clients.
• ACP & Zed Bridge Usage - the raw ACP protocol and Zed Editor integration (via patb-cli).