Skip to content

GETSTARTED.md

Latest commit

 

History

History
56 lines (39 loc) · 3.02 KB

GETSTARTED.md

File metadata and controls

56 lines (39 loc) · 3.02 KB
Raw

GetStarted

  1. Prerequisites
  • Node.js ≥ 22.19.0 (node --version)
  • An API key for at least one provider (or a subscription login once inside the app)
  1. Install and build (already done in this working tree, but for a fresh clone)

npm install --ignore-scripts # install all workspace deps, no lifecycle scripts npm run build # builds tui → ai → agent → coding-agent → orchestrator

  1. Run offsidepi from sources (the main dev loop)

./offsidepi-src/offsidepi-test.sh This runs offsidepi-src/packages/coding-agent/src/cli.ts via tsx directly — no rebuild needed after source edits, and it works from any directory. Useful variants: ./offsidepi-src/offsidepi-test.sh --no-env # start with all provider API keys stripped (test /login, key prompts) ./offsidepi-src/offsidepi-test.sh -p "hello" # non-interactive print mode: one prompt, then exit ./offsidepi-src/offsidepi-test.sh --help # confirm the offsidepi-branded help

Authenticate either way: export ANTHROPIC_API_KEY=sk-ant-... # env key (any supported provider's key works) ./offsidepi-src/offsidepi-test.sh or start it and type /login to use a subscription (Claude Pro/Max, ChatGPT, Copilot).

Everything lands in the fork's own config: sessions/settings/auth live under ~/.offsidepi/agent/ — your existing upstream ~/.pi is untouched.

  1. Run the built CLI (what npm users would get)

node offsidepi-src/packages/coding-agent/dist/cli.js --version node offsidepi-src/packages/coding-agent/dist/cli.js To get a global offsidepi command on your PATH from this checkout: cd offsidepi-src/packages/coding-agent && npm link && cd ../.. offsidepi # now works anywhere; npm unlink -g @offsideai/offsidepi-coding-agent to remove

  1. Run the test suites

./offsidepi-src/test.sh # canonical: moves ~/.offsidepi/agent/auth.json aside + strips API keys, # so LLM-dependent tests skip. Expect 1 known env failure on your machine # (resource-loader picks up your real ~/.agents/skills/agent-reach skill). npm test # full run WITH your keys → executes live provider tests ($ and slow) Per-package, e.g. just the coding agent: cd offsidepi-src/packages/coding-agent && npx vitest --run # whole package npx vitest --run test/config.test.ts # single file

  1. Lint / format / type-check (run before committing)

npm run check # biome + pinned-deps + shrinkwrap + install-lock + tsgo + browser smoke

  1. Optional: full release smoke test

npm run release:local # builds, packs, and does isolated npm + Bun installs outside the repo And npm run build:binary inside offsidepi-src/packages/coding-agent compiles a standalone dist/offsidepi binary with Bun, if you have Bun installed.

A tip for TUI verification without babysitting a terminal: AGENTS.md documents a tmux harness (tmux new-session -d -s offsidepi-test ... then tmux send-keys/capture-pane) for scripted interactive testing.