Skip to content

AGENTS.md

Latest commit

 

History

History
69 lines (52 loc) · 2.01 KB

AGENTS.md

File metadata and controls

69 lines (52 loc) · 2.01 KB

AGENTS.md

This file provides concise guidance to automation agents working in this repository.

Hard Constraints

  • Do not change any external CLI behavior/flags/output/protocols.
  • Keep gates green: bun run typecheck, bun run lint, bun test, bun run build:npm.
  • When a reference repo is available, keep parity green: KODE_REFERENCE_REPO=/path/to/legacy-kode-cli bun run parity:reference.

Development Commands

Workflow

# Install dependencies
bun install

# Run in development mode (hot reload with verbose output)
bun run dev

# Build npm runtime dist (Node.js runnable)
bun run build:npm
# (alias)
bun run build

# Clean build artifacts
bun run clean

# Run tests
bun test

# Check types
bun run typecheck

# Format code
bun run format
bun run format:check

Build System Details

  • Primary Build Tool: Bun (required for development)
  • Distribution: npm bin shims (cli.js, cli-acp.js) prefer cached standalone binaries, otherwise run node dist/index.js (no Bun runtime required)
  • Entry Point: src/entrypoints/cli.tsx
  • Build Output: dist/index.js (+ chunks), dist/package.json, dist/yoga.wasm, root cli.js, root cli-acp.js

Publishing

# Publish to npm (requires build first)
bun run build:npm
npm publish
# Or with bundled dependency check skip:
SKIP_BUNDLED_CHECK=true npm publish

Repo Map (Where Things Live)

  • src/entrypoints/: CLI/MCP/ACP entrypoints and orchestration
  • src/core/: core logic (must not depend on src/ui/)
  • src/services/: integrations, grouped by domain (ai/, mcp/, plugins/, system/, auth/, telemetry/, context/, ui/)
  • src/tools/: tool implementations (Bash/File/Grep/MCP/etc.)
  • src/ui/: Ink UI (screens/components/hooks)
  • src/utils/: reusable utilities (domain-grouped)
  • tests/: unit/, integration/, e2e/ (offline by default)

References

  • Release checklist: docs/release_checklist.md
  • Architecture notes: docs/upgrade_design.md
  • Task ledger: todo_tasks.json, todo_tasks_detail.md