co-mono/README.md
2026-03-05 19:32:56 -08:00

4.4 KiB

pi logo

Discord Build status

pi.dev domain graciously donated by

Exy mascot
exe.dev

pi

Looking for the pi coding agent? See packages/coding-agent for installation and usage.

Tools for building AI agents and managing LLM deployments.

Packages

Package Description
@mariozechner/pi-ai Unified multi-provider LLM API (OpenAI, Anthropic, Google, etc.)
@mariozechner/pi-agent-core Agent runtime with tool calling and state management
@mariozechner/pi-coding-agent Interactive coding agent CLI
@mariozechner/pi-mom Slack bot that delegates messages to the pi coding agent
@mariozechner/pi-tui Terminal UI library with differential rendering
@mariozechner/pi-web-ui Web components for AI chat interfaces
@mariozechner/pi-pods CLI for managing vLLM deployments on GPU pods

Contributing

See CONTRIBUTING.md for contribution guidelines and AGENTS.md for project-specific rules (for both humans and agents).

Install

Public (binary)

Use this for users on production machines where you don't want to expose source.

curl -fsSL https://raw.githubusercontent.com/getcompanion-ai/co-mono/main/public-install.sh | bash

Install everything and keep it always-on (recommended for new devices):

curl -fsSL https://raw.githubusercontent.com/getcompanion-ai/co-mono/main/public-install.sh | bash -s -- --daemon --start

This installer:

  • Downloads the latest release (or falls back to source when needed),
  • writes ~/.local/bin/pi launcher,
  • populates ~/.pi/agent/settings.json with package list,
  • installs packages (if npm is available),
  • and can install a user systemd service for pi gateway so it stays alive.

Preinstalled package sources are:

[
  "npm:@e9n/pi-channels",
  "npm:pi-memory-md",
  "npm:pi-teams"
]

If npm is available, it also installs these packages during install.

If no release asset is found, the installer falls back to source.

PI_FALLBACK_TO_SOURCE=0 \
  curl -fsSL https://raw.githubusercontent.com/getcompanion-ai/co-mono/main/public-install.sh | bash -s -- --daemon --start

public-install.sh options:

curl -fsSL https://raw.githubusercontent.com/getcompanion-ai/co-mono/main/public-install.sh | bash -s -- --help

Local (source)

git clone https://github.com/getcompanion-ai/co-mono.git
cd co-mono
./install.sh

Run:

./pi

Run in background with extensions active:

./pi gateway

For a user systemd setup, create ~/.config/systemd/user/pi.service with:

[Unit]
Description=pi gateway
After=network-online.target

[Service]
Type=simple
Environment=PI_CODING_AGENT_DIR=%h/.pi/agent
ExecStart=/absolute/path/to/repo/pi gateway
Restart=always
RestartSec=5

[Install]
WantedBy=default.target

Then enable:

systemctl --user daemon-reload
systemctl --user enable --now pi

Optional:

npm run build   # build all packages
npm run check   # lint/format/typecheck

Development

npm install          # Install all dependencies
npm run build        # Build all packages
npm run check        # Lint, format, and type check
./test.sh            # Run tests (skips LLM-dependent tests without API keys)
./pi-test.sh         # Run pi from sources (must be run from repo root)

Note: npm run check requires npm run build to be run first. The web-ui package uses tsc which needs compiled .d.ts files from dependencies.

License

MIT