mirror of https://github.com/harivansh-afk/clanker-agent.git synced 2026-04-15 12:03:49 +00:00

Harivansh Rathi 536241053c refactor: finish companion rename migration

Complete the remaining pi-to-companion rename across companion-os, web, vm-orchestrator, docker, and archived fixtures.

Verification:
- semantic rg sweeps for Pi/piConfig/getPi/.pi runtime references
- npm run check in apps/companion-os (fails in this worktree: biome not found)

Co-authored-by: Codex <noreply@openai.com>

2026-03-10 07:39:32 -05:00

1.3 KiB

Raw Blame History

Development

See AGENTS.md for additional guidelines.

Setup

git clone https://github.com/badlogic/companion-mono
cd companion-mono
npm install
npm run build

Run from source:

./companion-test.sh

Forking / Rebranding

Configure via package.json:

{
  "companionConfig": {
    "name": "companion",
    "configDir": ".companion"
  }
}

Change name, configDir, and bin field for your fork. Affects CLI banner, config paths, and environment variable names.

Path Resolution

Three execution modes: npm install, standalone binary, tsx from source.

Always use src/config.ts for package assets:

import { getPackageDir, getThemeDir } from "./config.js";

Never use __dirname directly for package assets.

Debug Command

/debug (hidden) writes to ~/.companion/agent/companion-debug.log:

Rendered TUI lines with ANSI codes
Last messages sent to the LLM

Testing

./test.sh                         # Run non-LLM tests (no API keys needed)
npm test                          # Run all tests
npm test -- test/specific.test.ts # Run specific test

Project Structure

packages/
  ai/           # LLM provider abstraction
  agent/        # Agent loop and message types
  tui/          # Terminal UI components
  coding-agent/ # CLI and interactive mode

1.3 KiB Raw Blame History