ZacharyZhang-NY
6f31415ed6
The PRD's first acceptance gate now holds: grep -RinE '\bx\.ai\b|grok' crates/ --include='*.rs' → 0 matches (exempt: NOTICE and third-party license archives, README provenance, and the required 'Based on Grok Build Open Source' attribution, now sourced from version_attribution.txt). Wire-visible renames (both sides in this repo, changed in lockstep): - Auth method id 'grok.com' → 'kimi-code' (AuthMethodKind::KimiCode). - Every x.ai/* and _x.ai/* ACP ext method and meta key → kigi/* / _kigi/* (~200 names; grokShell → kigiShell). Session-file replay keeps a read-side alias for the legacy '_x.ai/session/update' method so existing updates.jsonl histories load; writes emit only the new name (both directions test-pinned). - Agent types grok-build* → kigi* with a documented legacy-prefix alias at resolution time so persisted sessions keep resolving. - ToolNamespace/BuiltinAgentName GrokBuild* → Kigi* (wire snake_case kigi/kigi_concise/kigi_hashline; schema regenerated); grok_build implementation dirs renamed to kigi*. - x-grok-* headers → x-kigi-*, __GROK_* sentinels → __KIGI_*, themes grokday/groknight → kigiday/kiginight (old persisted values fall back to the default theme), web_fetch allowlist xAI hosts → kimi.com + moonshot platforms, changelog CDN → this repo, grok-build changelog archives deleted. - BYOK default endpoint removed: [endpoints] api_base_url is now truly optional with NO default — consumers fail fast with the flag name when unset (no silent x.ai egress). Mock harnesses inject it explicitly. - System-prompt identity fixed: 'released by xAI' → 'an unofficial community CLI for Kimi' (template + regenerated encrypted form). Also repaired pre-existing grok-era test debt found by the sweep: the stale trace_classify default-model pin, the grok-pager UA label test, pty-harness stale-binary reuse and non-hermetic moonshot routing (a PTY test could previously reach the real api.moonshot.cn), and the outdated oauth fixture scope key. Gates: §9 grep 0; fmt clean; workspace check/clippy 0/0 (-D warnings); FULL cargo test --workspace: 234 suites, 21,961 passed, 0 failed; deny advisories ok.
230 lines
8.6 KiB
Markdown
230 lines
8.6 KiB
Markdown
# Project Rules (AGENTS.md)
|
|
|
|
Project rules let you configure Kigi per project or directory. By placing an AGENTS.md file in your repository, you can set coding conventions, build instructions, style guides, and any other instructions that Kigi should follow when working in that codebase.
|
|
|
|
---
|
|
|
|
## What Are Project Rules?
|
|
|
|
Project rules are Markdown files that Kigi reads and adds to its context. Kigi follows their content for every interaction in that tree.
|
|
|
|
This is the primary mechanism for teaching Kigi about your project's conventions, so you need not restate them each session.
|
|
|
|
---
|
|
|
|
## Supported File Names
|
|
|
|
Kigi checks for these filenames (in this order) within each directory:
|
|
|
|
- `Agents.md`
|
|
- `Claude.md`
|
|
- `CLAUDE.md`
|
|
- `CLAUDE.local.md`
|
|
- `AGENT.md`
|
|
- `AGENTS.md`
|
|
|
|
Kigi loads every matching file in a directory, so a folder that contains both `AGENTS.md` and `CLAUDE.md` contributes both. On case-insensitive filesystems, names that resolve to the same file (such as `Agents.md` and `AGENTS.md`) are deduplicated and counted once. `Claude.md`, `CLAUDE.md`, and `CLAUDE.local.md` are supported for compatibility with Claude Code workflows. When Claude compatibility is enabled (the default), Kigi also scans your home-level `~/.claude/` directory for these filenames and, at each directory level, checks `.claude/CLAUDE.md` and `.claude/CLAUDE.local.md` -- the locations Claude Code uses for project memory. With Cursor compatibility enabled, the home-level `~/.cursor/` directory is scanned the same way.
|
|
|
|
### Rules Directories
|
|
|
|
In addition to AGENTS.md files, Kigi scans for `*.md` files in rules directories at each level (`<dir>`) from the repo root to the current working directory:
|
|
|
|
| Location | Notes |
|
|
|----------|-------|
|
|
| `<dir>/.kigi/rules/` | Always scanned |
|
|
| `<dir>/.claude/rules/` | Claude compatibility (configurable) |
|
|
| `<dir>/.cursor/rules/` | Cursor compatibility (configurable) |
|
|
|
|
Kigi scans the Claude and Cursor rules directories by default. To disable scanning for a specific vendor, set its cell in the `[compat]` config section or the corresponding environment variable. See [Configuration](05-configuration.md#harness-compatibility) for details.
|
|
|
|
---
|
|
|
|
## How Discovery Works
|
|
|
|
Kigi scans for project rules in this order:
|
|
|
|
1. **Global rules**: `~/.kigi/` (applies to all projects)
|
|
2. **Repo rules**: If inside a git repo, every directory from the repo root down to the current working directory (inclusive)
|
|
3. **CWD-only**: If not inside a git repo, only the current working directory
|
|
|
|
### Example
|
|
|
|
Given this project structure:
|
|
|
|
```
|
|
~/projects/my-app/
|
|
AGENTS.md # "Use TypeScript. Follow ESLint rules."
|
|
src/
|
|
AGENTS.md # "Prefer functional components."
|
|
components/
|
|
AGENTS.md # "Use CSS modules for styling."
|
|
```
|
|
|
|
When Kigi runs in `~/projects/my-app/src/components/`, it loads all three files. The instructions accumulate, so Kigi sees all of them.
|
|
|
|
### Deeper Files Take Precedence
|
|
|
|
Kigi orders the files from the repo root to the current working directory, so files in deeper directories appear later in its context and take precedence when instructions conflict. In the example above, if the root says "Use styled-components" but `components/AGENTS.md` says "Use CSS modules", the CSS modules instruction wins because it appears later.
|
|
|
|
### Auto-Loading Behavior
|
|
|
|
- Kigi loads the files from the repo root to the current working directory automatically at session start.
|
|
- When Kigi reads, lists, or edits files in directories outside that initial set, it detects any project instruction files there, notes their paths, and reads them when they apply to the task.
|
|
|
|
---
|
|
|
|
## What to Put in Project Rules
|
|
|
|
### Coding Conventions
|
|
|
|
```markdown
|
|
# Coding Standards
|
|
|
|
- Use TypeScript for all new code
|
|
- Prefer functional components with hooks over class components
|
|
- Use `const` by default; only use `let` when reassignment is needed
|
|
- Maximum line length: 100 characters
|
|
```
|
|
|
|
### Build and Test Instructions
|
|
|
|
```markdown
|
|
# Build & Test
|
|
|
|
- Run `npm test` before committing
|
|
- Use `npm run lint` to check code style
|
|
- Build with `npm run build` -- ensure no TypeScript errors
|
|
- Integration tests: `npm run test:e2e` (requires Docker)
|
|
```
|
|
|
|
### Style Guides
|
|
|
|
```markdown
|
|
# Style Guide
|
|
|
|
- Follow the Airbnb JavaScript Style Guide
|
|
- Use 2-space indentation
|
|
- Always use trailing commas in multi-line arrays/objects
|
|
- Prefer template literals over string concatenation
|
|
```
|
|
|
|
### PR and Commit Requirements
|
|
|
|
```markdown
|
|
# Version Control
|
|
|
|
- Write commit messages in conventional commits format
|
|
- Prefix branch names with `feature/`, `fix/`, or `chore/`
|
|
- All PRs require at least one approval before merge
|
|
- Squash-merge feature branches
|
|
```
|
|
|
|
### Architecture Notes
|
|
|
|
```markdown
|
|
# Architecture
|
|
|
|
- API routes go in `src/routes/` with one file per resource
|
|
- Business logic goes in `src/services/`
|
|
- Database queries go in `src/repositories/`
|
|
- Never import from `src/routes/` in `src/services/`
|
|
```
|
|
|
|
---
|
|
|
|
## Scoping Rules to Subdirectories
|
|
|
|
AGENTS.md files scope to the entire directory tree rooted at their folder. Use this to provide different instructions for different parts of your codebase:
|
|
|
|
```
|
|
my-monorepo/
|
|
AGENTS.md # Monorepo-wide rules
|
|
packages/
|
|
frontend/
|
|
AGENTS.md # "Use React. Prefer CSS modules."
|
|
backend/
|
|
AGENTS.md # "Use Express. Follow REST conventions."
|
|
shared/
|
|
AGENTS.md # "No framework-specific code in this package."
|
|
```
|
|
|
|
---
|
|
|
|
## Session Rules Flags
|
|
|
|
To add rules for a single session without editing files, pass `--rules` (alias `--append-system-prompt`):
|
|
|
|
```bash
|
|
kigi --rules "Always use TypeScript. Prefer functional components."
|
|
```
|
|
|
|
Kigi appends this text to the session's system prompt. Use it for session-specific customization.
|
|
|
|
To replace the system prompt entirely, pass `--system-prompt-override` (alias `--system-prompt`). Kigi uses the text verbatim and skips both the default system prompt and `--rules`. (Text passed with `--rules`, by contrast, is wrapped in a `<human_rules>` block and appended to the default prompt.)
|
|
|
|
---
|
|
|
|
## File Size
|
|
|
|
Kigi loads each project instruction file in full; there is no character cap and no truncation. Even so, keep instructions concise and focused. Shorter, specific rules are easier for Kigi to follow than long ones, and every file you load consumes context.
|
|
|
|
---
|
|
|
|
## Gitignore Filtering
|
|
|
|
Files ignored by `.gitignore` are skipped during discovery. To keep personal overrides out of the shared repository, gitignore a recognized filename such as `CLAUDE.local.md`:
|
|
|
|
```gitignore
|
|
# .gitignore
|
|
CLAUDE.local.md
|
|
```
|
|
|
|
As top-level instruction files, Kigi discovers only the recognized filenames listed under [Supported File Names](#supported-file-names) — not custom names such as `AGENTS.local.md` or `notes.md`. (Inside a rules directory such as `.kigi/rules/`, every `*.md` file is loaded regardless of name.)
|
|
|
|
---
|
|
|
|
## The .kigi/ Project Directory
|
|
|
|
Beyond AGENTS.md files, the `.kigi/` directory in your project root can contain additional project-level configuration:
|
|
|
|
| Path | Purpose |
|
|
|------|---------|
|
|
| `.kigi/config.toml` | Project-scoped MCP servers, plugins, and permission rules (other settings load only from `~/.kigi/config.toml`) |
|
|
| `.kigi/skills/` | Project-scoped skill definitions |
|
|
| `.kigi/plugins/` | Project-scoped plugins |
|
|
| `.kigi/agents/` | Project-scoped agent definitions |
|
|
| `.kigi/hooks/` | Project-scoped lifecycle hooks |
|
|
| `.kigi/lsp.json` | LSP server configuration |
|
|
|
|
These are all optional. See the respective guides for details on each.
|
|
|
|
---
|
|
|
|
## Inspecting Loaded Rules
|
|
|
|
Use `kigi inspect` to see all loaded project instructions:
|
|
|
|
```bash
|
|
kigi inspect
|
|
```
|
|
|
|
This shows each project instruction file it finds, with its path and approximate token count. Use it to confirm Kigi picks up your rules.
|
|
|
|
---
|
|
|
|
## Best Practices
|
|
|
|
1. **Start with the root.** Put the most important, project-wide rules in the repo root AGENTS.md.
|
|
|
|
2. **Be specific.** "Use TypeScript" is better than "Use modern JavaScript". "Run `cargo fmt` before committing" is better than "Format your code".
|
|
|
|
3. **Keep it short.** Concise instructions are more likely to be followed than lengthy ones.
|
|
|
|
4. **Use subdirectory scoping for large repos.** Different parts of a monorepo may have different conventions. Use per-directory AGENTS.md to scope rules appropriately.
|
|
|
|
5. **Version control your rules.** Commit AGENTS.md to the repository so the whole team benefits. User-specific overrides belong in `~/.kigi/` (global rules).
|
|
|
|
6. **Do not duplicate documentation.** AGENTS.md should contain actionable instructions, not a copy of your project's README. Link to external docs if needed.
|
|
|
|
7. **Review periodically.** As your project evolves, update your rules to match current conventions.
|