bird-chinese-community/BIRD.skills / bird-agent
bird-agent
VerifiedWrite, review, discover, lint, format, and validate BIRD 2/3 routing-daemon projects with the @birdcc toolchain. Use for bird.conf, bird2.conf, bird3.conf, bird6.conf, .bird/.bird2/.bird3 files, bird.config.json, birdcc.config.json, include graphs, BIRD filters and protocols, birdcc init/lint/fmt/lsp, or bird -p checks. Treat BIRD 1 as legacy and verify it with the actual BIRD 1 binary. Route editor and CLI installation to birdcc-installer, GitHub Actions to birdcc-cicd, runtime incidents to bird-troubleshooting, and implementation archaeology to bird-source-explorer.
| File | Kind | Size |
|---|---|---|
| .mcp.json | config | 227 B |
| SKILL.md | skill md | 5.6 KB |
| agents/openai.yaml | config | 381 B |
| assets/logo-small.png | binary | 2.9 KB |
| assets/logo.png | binary | 6.5 KB |
| evals/evals.json | config | 5.5 KB |
| evals/fixtures/bird-unformatted.conf | config | 147 B |
| evals/fixtures/bird.conf | config | 144 B |
| evals/fixtures/cross-file/main.conf | config | 44 B |
| evals/fixtures/cross-file/peers.conf | config | 122 B |
| metadata.json | config | 527 B |
| plugin.json | config | 554 B |
| references/birdcc-ecosystem.md | markdown | 5.7 KB |
| references/cicd.md | markdown | 718 B |
| references/editors.md | markdown | 742 B |
| references/examples.md | markdown | 1.6 KB |
| references/project-config.md | markdown | 3.3 KB |
| references/safety.md | markdown | 1.2 KB |
| references/toolchain.md | markdown | 3.0 KB |
| scripts/detect_bird_context.py | script | 7.4 KB |
| scripts/run_birdcc.py | script | 7.0 KB |
references/project-config.md
View on GitHub# BIRD Project Configuration
Use this reference for entry-point discovery, multi-router repositories, include resolution, and
`birdcc init`.
## Discovery contract
The current CLI searches upward from a target file for these names, in this order:
1. `bird.config.json` — preferred and generated by `birdcc init`.
2. `birdcc.config.json` — backwards-compatible alias.
Do not invent versioned names such as `bird2.config.json` or `bird3.config.json`.
Start with a read-only scan:
```bash
birdcc init . --dry-run --json
```
Use `--max-depth`, `--max-files`, or `--ignore` for a large repository. The detector classifies
entry candidates and avoids treating included fragments or unrelated `.conf` files as roots.
Only write after approval:
```bash
birdcc init . --write
```
Do not use `--force` until the existing config has been read and the user explicitly approves
replacement.
## Schema
Use the canonical schema URL:
```json
{
"$schema": "https://raw.githubusercontent.com/bird-chinese-community/BIRD-LSP/main/schemas/bird.config.schema.json",
"main": "./bird.conf",
"bird": {
"version": "^3.0",
"binaryPath": "/usr/sbin/bird",
"validateCommand": "bird -p -c {file}"
},
"includePaths": ["./filters", "./peers"],
"crossFile": {
"enabled": true,
"maxDepth": 16,
"maxFiles": 256,
"externalIncludes": false
},
"formatter": {
"engine": "dprint",
"indentSize": 2,
"lineWidth": 80,
"safeMode": true
},
"linter": {
"enabled": true,
"withBird": true,
"rules": {
"sym/*": "error",
"bgp/*": "warning"
}
}
}
```
`birdcc-tooling.schema.json` is a deprecated schema alias. Migrate new and edited projects to
`bird.config.schema.json`.
## Repository shapes
### One entry
Set `main` to a path relative to the project config:
```json
{ "main": "./bird.conf" }
```
### Multiple independent router workspaces
Use `workspaces` globs. When `workspaces` is present, `birdcc lint` with no explicit file resolves
each matching workspace entry:
```json
{ "workspaces": ["sites/*", "!sites/legacy"] }
```
Do not pass an implicit workspace set to commands that require a concrete single target unless the
CLI explicitly supports it.
### One entry with multiple role variable files
Use `roles`:
```json
{
"main": "./bird.conf",
"roles": [
{ "name": "edge-a", "vars": "./routers/edge-a.conf" },
{ "name": "edge-b", "vars": "./routers/edge-b.conf" }
]
}
```
Roles describe reusable variable sets. They do not replace native validation for each rendered or
deployed router configuration.
## Include boundaries
`includePaths` adds search roots. `crossFile.externalIncludes` defaults to `false`; keep it false
unless the repository intentionally owns includes outside its root. Raising `maxDepth` or
`maxFiles` expands the amount of content analyzed and should be justified by the actual include
graph.
## Precedence
- CLI flags override project configuration.
- `bird.validateCommand` overrides `bird.binaryPath`.
- `bird.binaryPath` is used before `BIRD_BIN`, which is used before normal `PATH` discovery.
- Exact linter rule codes override wildcard groups such as `bgp/*`.
Treat any custom validation command in a repository as executable workspace configuration. Show it
to the user before running it in an untrusted checkout.
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| reverse-engineer-anythingmorluto/reaReverse engineer native, managed, Electron/JavaScript, packaged, firmware, and browser targets with REA, and build agent environments (AgentEnv bundles) of web applications from a live instance or a capture, and of Linux desktop apps with a task from a request. Use shipped-artifact or requested runtime evidence to explain features, compare versions, decompile code, or guide a reconstruction. Skip REA for ordinary source-repository architecture analysis. | Stars: 472k | Updated | Claude CodeCodex | Verified | Install |
| diagnosing-superpowersobra/superpowersUse when a superpowers session went wrong and your human partner wants to know why — repeated work, ignored plans, stumbles, poor results, a skill that didn't fire, "it took too long", "why is it so expensive", "what is it doing" — or wants to build a bug report for the superpowers maintainers, for the current session or a past one identified by id or path, on any harness. | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| dispatching-parallel-agentsobra/superpowersUse when facing 2+ independent tasks that can be worked on without shared state or sequential dependencies | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| executing-plansobra/superpowersUse when executing an implementation plan in the current session as the implementer yourself — your human partner chose inline execution, or no subagent tool is available | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |