Skip to content

everydaydevopsio/ballast

Repository files navigation

Ballast

CI Lint Release (npm) Release (Go) Release (Python)

Ballast installs AI agent rules for Cursor, Claude Code, OpenCode, and Codex.

Release v4.0.0 supports three first-class language profiles in this repository:

  • TypeScript
  • Python
  • Go

Packages

  • @everydaydevopsio/ballast (npm)
  • ballast-python (GitHub Releases artifact)
  • ballast-go (Go)

Agent Model

Common agents (all languages):

  • local-dev
  • cicd
  • observability

Language-specific agents:

  • TypeScript: linting, logging, testing
  • Python: linting, logging, testing
  • Go: linting, logging, testing

Agent sources in this repo:

  • agents/common/*
  • agents/typescript/*
  • agents/python/*
  • agents/go/*

Install and Use (Single Language)

TypeScript (npm)

pnpm add -D @everydaydevopsio/ballast
npx ballast install --target cursor --all

Python

VERSION=4.0.0
uv tool install --from "https://github.com/everydaydevopsio/ballast/releases/download/v${VERSION}/ballast_python-${VERSION}-py3-none-any.whl" ballast
ballast install --target cursor --all
# or
uvx --from "https://github.com/everydaydevopsio/ballast/releases/download/v${VERSION}/ballast_python-${VERSION}-py3-none-any.whl" ballast install --target codex --agent linting

Go

go install github.com/everydaydevopsio/ballast/packages/ballast-go/cmd/ballast@latest
ballast install --target cursor --all

Monorepo: Install and Use by Language

In a monorepo that contains TypeScript, Python, and Go projects, run Ballast once per language profile.

1. TypeScript rules in a monorepo

npx ballast install --target cursor --all

2. Python rules in a monorepo

VERSION=4.0.0
uvx --from "https://github.com/everydaydevopsio/ballast/releases/download/v${VERSION}/ballast_python-${VERSION}-py3-none-any.whl" ballast install --target cursor --all

3. Go rules in a monorepo

go run github.com/everydaydevopsio/ballast/packages/ballast-go/cmd/ballast@latest install --target cursor --all

Recommended order for one repository that uses all three languages:

  1. Run the TypeScript command.
  2. Run the Python command.
  3. Run the Go command.

Ballast only installs shipped agents and follows the single overwrite policy (existing rule files are preserved unless --force is passed).

CLI Flags

  • --target, -t: cursor, claude, opencode, codex
  • --agent, -a: comma-separated agent list
  • --all: install all agents for the selected language
  • --force, -f: overwrite existing rule files
  • --yes, -y: non-interactive mode

Config Files

  • TypeScript CLI: .rulesrc.ts.json
  • Python CLI: .rulesrc.python.json
  • Go CLI: .rulesrc.go.json

Install Locations

  • Cursor: .cursor/rules/<agent>.mdc
  • Claude: .claude/rules/<agent>.md
  • OpenCode: .opencode/<agent>.md
  • Codex: .codex/rules/<agent>.md and root AGENTS.md

Development

nvm install
pnpm install
pnpm test
pnpm run lint
pnpm run build

License

MIT

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors