Skip to content

BlackKingBarOrg/cirby

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

1 Commit
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Cirby 🩷

Merge AI coding agent configs into the unified AGENTS.md standard.

Cirby = Code + Kirby β€” absorbs all your agent configs and unifies them into one.

The Problem

Different AI coding agents use different configuration files:

Agent Config File
Claude Code CLAUDE.md
Cursor .cursorrules, .cursor/rules/*.mdc
Windsurf .windsurfrules
GitHub Copilot .github/copilot-instructions.md
Codex CODEX.md
OpenCode, AMP AGENTS.md βœ“

This creates friction when your team uses different tools, and makes it hard to maintain consistent instructions across agents.

The Solution

cirby scans your project, merges all agent configs into AGENTS.md, and creates symlinks so each tool still finds its expected file.

$ cirby
Scanning for agent configuration files...
  βœ“ CLAUDE.md (Claude Code)
  βœ“ .cursorrules (Cursor)
  βœ“ .windsurfrules (Windsurf)

βœ“ Created/updated AGENTS.md
βœ“ Symlinked CLAUDE.md β†’ AGENTS.md
βœ“ Symlinked .cursorrules β†’ AGENTS.md
βœ“ Symlinked .windsurfrules β†’ AGENTS.md

πŸŽ‰ Done!

Installation

Go Install

go install github.com/BlackKingBarOrg/cirby@latest

From Source

git clone https://github.com/BlackKingBarOrg/cirby.git
cd cirby
go build -o cirby .

Download Binary

Check the Releases page for pre-built binaries.

Usage

# Merge configs and create symlinks
cirby

# Preview changes without modifying files
cirby --dry-run

# Skip git uncommitted changes check
cirby --force

# Verbose output
cirby --verbose

Safety Features

Git Protection

Cirby requires agent config files to be committed before merging. This ensures you can always rollback via git:

$ cirby
Error: uncommitted changes detected in agent config files:
  - CLAUDE.md (modified)
  - .cursorrules (untracked)

Please commit first so you can rollback if needed:
  git add CLAUDE.md .cursorrules
  git commit -m "backup before cirby"

Use --force to skip this check (not recommended).

Idempotency

Running cirby multiple times is safe. It detects existing symlinks and unchanged content, only updating when necessary.

How It Works

  1. Scan β€” Find all agent config files in your project
  2. Merge β€” Combine content into AGENTS.md (with deduplication)
  3. Symlink β€” Replace original files with symlinks to AGENTS.md

After running cirby:

project/
β”œβ”€β”€ AGENTS.md           ← The source of truth
β”œβ”€β”€ CLAUDE.md           β†’ symlink to AGENTS.md
β”œβ”€β”€ .cursorrules        β†’ symlink to AGENTS.md
β”œβ”€β”€ .windsurfrules      β†’ symlink to AGENTS.md
└── .github/
    └── copilot-instructions.md β†’ symlink to ../AGENTS.md

Contributing

Issues and PRs welcome! This project uses the AGENTS.md standard (of course).

License

MIT

Credits

Named after Kirby, the Nintendo character who absorbs abilities from others. Cirby absorbs your agent configs and unifies them. 🩷

About

Merge AI coding agent configs into AGENTS.md 🩷

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages