mirror of
https://github.com/getcompanion-ai/co-mono.git
synced 2026-04-15 22:03:45 +00:00
117 lines
No EOL
3.7 KiB
Markdown
117 lines
No EOL
3.7 KiB
Markdown
# Pi Monorepo
|
|
|
|
Tools for building AI agents and managing LLM deployments.
|
|
|
|
## Packages
|
|
|
|
| Package | Description |
|
|
|---------|-------------|
|
|
| **[@mariozechner/pi-ai](packages/ai)** | Unified multi-provider LLM API (OpenAI, Anthropic, Google, etc.) |
|
|
| **[@mariozechner/pi-agent](packages/agent)** | Agent runtime with tool calling and state management |
|
|
| **[@mariozechner/pi-coding-agent](packages/coding-agent)** | Interactive coding agent CLI |
|
|
| **[@mariozechner/pi-mom](packages/mom)** | Slack bot that delegates messages to the pi coding agent |
|
|
| **[@mariozechner/pi-tui](packages/tui)** | Terminal UI library with differential rendering |
|
|
| **[@mariozechner/pi-web-ui](packages/web-ui)** | Web components for AI chat interfaces |
|
|
| **[@mariozechner/pi-proxy](packages/proxy)** | CORS proxy for browser-based LLM API calls |
|
|
| **[@mariozechner/pi](packages/pods)** | CLI for managing vLLM deployments on GPU pods |
|
|
|
|
## Development
|
|
|
|
### Setup
|
|
|
|
```bash
|
|
npm install # Install all dependencies
|
|
npm run build # Build all packages
|
|
npm run check # Lint, format, and type check
|
|
```
|
|
|
|
### CI
|
|
|
|
GitHub Actions runs on push to `main` and on pull requests. The workflow runs `npm run check` and `npm run test` for each package in parallel.
|
|
|
|
**Do not add LLM API keys as secrets to this repository.** Tests that require LLM access use `describe.skipIf()` to skip when API keys are missing. This is intentional:
|
|
|
|
- PRs from external contributors would have access to secrets in the CI environment
|
|
- Malicious PR code could exfiltrate API keys
|
|
- Tests that need LLM calls are skipped on CI and run locally by developers who have keys configured
|
|
|
|
If you need to run LLM-dependent tests, run them locally with your own API keys.
|
|
|
|
### Development
|
|
|
|
Start watch builds for all packages:
|
|
```bash
|
|
npm run dev
|
|
```
|
|
|
|
Then run with tsx:
|
|
```bash
|
|
cd packages/coding-agent && npx tsx src/cli.ts
|
|
cd packages/pods && npx tsx src/cli.ts
|
|
```
|
|
|
|
### Versioning (Lockstep)
|
|
|
|
**All packages MUST always have the same version number.** Use these commands to bump versions:
|
|
|
|
```bash
|
|
npm run version:patch # 0.7.5 -> 0.7.6
|
|
npm run version:minor # 0.7.5 -> 0.8.0
|
|
npm run version:major # 0.7.5 -> 1.0.0
|
|
```
|
|
|
|
These commands:
|
|
1. Update all package versions to the same number
|
|
2. Update inter-package dependency versions (e.g., `pi-agent` depends on `pi-ai@^0.7.7`)
|
|
3. Update `package-lock.json`
|
|
|
|
**Never manually edit version numbers.** The lockstep system ensures consistency across the monorepo.
|
|
|
|
### Publishing
|
|
|
|
Complete release process:
|
|
|
|
1. **Add changes to CHANGELOG.md** (if changes affect coding-agent):
|
|
```bash
|
|
# Add your changes to the [Unreleased] section in packages/coding-agent/CHANGELOG.md
|
|
# Always add new entries under [Unreleased], never under already-released versions
|
|
```
|
|
|
|
2. **Bump version** (all packages):
|
|
```bash
|
|
npm run version:patch # For bug fixes
|
|
npm run version:minor # For new features
|
|
npm run version:major # For breaking changes
|
|
```
|
|
|
|
3. **Finalize CHANGELOG.md for release** (if changes affect coding-agent):
|
|
```bash
|
|
# Change [Unreleased] to the new version number with today's date
|
|
# e.g., ## [0.7.16] - 2025-11-17
|
|
# NEVER add entries to already-released version sections
|
|
# Each version section is immutable once released
|
|
```
|
|
|
|
4. **Commit and tag**:
|
|
```bash
|
|
git add .
|
|
git commit -m "Release v0.7.16"
|
|
git tag v0.7.16
|
|
git push origin main
|
|
git push origin v0.7.16
|
|
```
|
|
|
|
5. **Publish to npm**:
|
|
```bash
|
|
npm run publish # Publish all packages to npm
|
|
```
|
|
|
|
6. **Add new [Unreleased] section** (for next development cycle):
|
|
```bash
|
|
# Add a new [Unreleased] section at the top of CHANGELOG.md
|
|
# Commit: git commit -am "Add [Unreleased] section"
|
|
```
|
|
|
|
## License
|
|
|
|
MIT |