mergegate/AGENTS.md

Repository Guidelines

Project Structure & Module Organization

• Rust workspace lives under crates/: miyabi-cli (CLI entry), miyabi-tui (UI), and miyabi-core (shared logic, config, sessions). Shared workspace config in Cargo.toml.
• TypeScript side sits in src/ with index.ts as the entry point; Vitest specs live in tests/. Build artifacts output to dist/.
• Supporting assets: .claude/ agent configs, docs/ for design notes, .miyabi/ for local runtime data, and .github/ for CI workflows.

Build, Test, and Development Commands

• Rust: cargo build --workspace --release (release build), cargo test --all (unit/integration), cargo clippy --all-targets -- -D warnings (lint), cargo fmt --all (format).
• TypeScript: npm run dev (tsx watch), npm run build (tsc emit to dist/), npm run typecheck (tsc no emit), npm run lint (eslint per .eslintrc.json), npm test (vitest).
• Install toolchains: npm install for JS deps; Rust uses stable 1.75+ per workspace metadata.

Coding Style & Naming Conventions

• Rust: run cargo fmt before commits; clippy must be clean with -D warnings. Modules/files use snake_case, types/traits PascalCase, constants SCREAMING_SNAKE_CASE. Prefer anyhow::Result and thiserror for errors; avoid unwrap in non-test code.
• TypeScript: strict mode on; avoid any (warned), silence unused via _ prefix. Follow ESLint rules and keep imports sorted logically. Prefer async/await over callbacks.

Testing Guidelines

• Rust tests colocated in each crate (mod tests blocks or tests/ directories); write integration tests when touching cross-crate behavior. Run cargo test --all before PRs.
• TypeScript tests follow *.test.ts in tests/; structure with describe/it and keep fast. Aim to cover error paths and CLI flags.

Commit & Pull Request Guidelines

• Use Conventional Commits (feat:, fix:, refactor:, docs:, test:, chore:). Keep subject under ~72 chars; include scope when helpful (feat(tui): add diff renderer).
• PRs should describe the change, linked issue, and test evidence (cargo test --all, npm test, etc.). Add screenshots or terminal recordings for TUI changes when relevant. Keep diffs focused; separate refactors from feature work.

Environment & Configuration

• Environment defaults from .env.example; typical variables: GITHUB_TOKEN, ANTHROPIC_API_KEY, REPOSITORY, optional RUST_LOG/RUST_BACKTRACE for debugging.
• Local config/state lives in ~/.miyabi/ and .miyabi/ (do not commit secrets). Review .miyabi.yml for runtime behavior before modifying agent workflows.

GitNexus — Code Intelligence

This project is indexed by GitNexus as miyabi-cli-standalone (5232 symbols, 11415 relationships, 300 execution flows). Use the GitNexus MCP tools to understand code, assess impact, and navigate safely.

If any GitNexus tool warns the index is stale, run npx gitnexus analyze in terminal first.

Always Do

• MUST run impact analysis before editing any symbol. Before modifying a function, class, or method, run gitnexus_impact({target: "symbolName", direction: "upstream"}) and report the blast radius (direct callers, affected processes, risk level) to the user.
• MUST run gitnexus_detect_changes() before committing to verify your changes only affect expected symbols and execution flows.
• MUST warn the user if impact analysis returns HIGH or CRITICAL risk before proceeding with edits.
• When exploring unfamiliar code, use gitnexus_query({query: "concept"}) to find execution flows instead of grepping. It returns process-grouped results ranked by relevance.
• When you need full context on a specific symbol — callers, callees, which execution flows it participates in — use gitnexus_context({name: "symbolName"}).

When Debugging

1. gitnexus_query({query: "<error or symptom>"}) — find execution flows related to the issue
2. gitnexus_context({name: "<suspect function>"}) — see all callers, callees, and process participation
3. READ gitnexus://repo/miyabi-cli-standalone/process/{processName} — trace the full execution flow step by step
4. For regressions: gitnexus_detect_changes({scope: "compare", base_ref: "main"}) — see what your branch changed

When Refactoring

• Renaming: MUST use gitnexus_rename({symbol_name: "old", new_name: "new", dry_run: true}) first. Review the preview — graph edits are safe, text_search edits need manual review. Then run with dry_run: false.
• Extracting/Splitting: MUST run gitnexus_context({name: "target"}) to see all incoming/outgoing refs, then gitnexus_impact({target: "target", direction: "upstream"}) to find all external callers before moving code.
• After any refactor: run gitnexus_detect_changes({scope: "all"}) to verify only expected files changed.

Never Do

• NEVER edit a function, class, or method without first running gitnexus_impact on it.
• NEVER ignore HIGH or CRITICAL risk warnings from impact analysis.
• NEVER rename symbols with find-and-replace — use gitnexus_rename which understands the call graph.
• NEVER commit changes without running gitnexus_detect_changes() to check affected scope.

Tools Quick Reference

Tool	When to use	Command
query	Find code by concept	gitnexus_query({query: "auth validation"})
context	360-degree view of one symbol	gitnexus_context({name: "validateUser"})
impact	Blast radius before editing	gitnexus_impact({target: "X", direction: "upstream"})
detect_changes	Pre-commit scope check	gitnexus_detect_changes({scope: "staged"})
rename	Safe multi-file rename	gitnexus_rename({symbol_name: "old", new_name: "new", dry_run: true})
cypher	Custom graph queries	gitnexus_cypher({query: "MATCH ..."})

Impact Risk Levels

Depth	Meaning	Action
d=1	WILL BREAK — direct callers/importers	MUST update these
d=2	LIKELY AFFECTED — indirect deps	Should test
d=3	MAY NEED TESTING — transitive	Test if critical path

Resources

Resource	Use for
gitnexus://repo/miyabi-cli-standalone/context	Codebase overview, check index freshness
gitnexus://repo/miyabi-cli-standalone/clusters	All functional areas
gitnexus://repo/miyabi-cli-standalone/processes	All execution flows
gitnexus://repo/miyabi-cli-standalone/process/{name}	Step-by-step execution trace

Self-Check Before Finishing

Before completing any code modification task, verify:

1. gitnexus_impact was run for all modified symbols
2. No HIGH/CRITICAL risk warnings were ignored
3. gitnexus_detect_changes() confirms changes match expected scope
4. All d=1 (WILL BREAK) dependents were updated

Keeping the Index Fresh

After committing code changes, the GitNexus index becomes stale. Re-run analyze to update it:

npx gitnexus analyze

If the index previously included embeddings, preserve them by adding --embeddings:

npx gitnexus analyze --embeddings

To check whether embeddings exist, inspect .gitnexus/meta.json — the stats.embeddings field shows the count (0 means no embeddings). Running analyze without --embeddings will delete any previously generated embeddings.

Claude Code users: A PostToolUse hook handles this automatically after git commit and git merge.

CLI

Task	Read this skill file
Understand architecture / "How does X work?"	.claude/skills/gitnexus/gitnexus-exploring/SKILL.md
Blast radius / "What breaks if I change X?"	.claude/skills/gitnexus/gitnexus-impact-analysis/SKILL.md
Trace bugs / "Why is X failing?"	.claude/skills/gitnexus/gitnexus-debugging/SKILL.md
Rename / extract / split / refactor	.claude/skills/gitnexus/gitnexus-refactoring/SKILL.md
Tools, resources, schema reference	.claude/skills/gitnexus/gitnexus-guide/SKILL.md
Index, status, clean, wiki CLI commands	.claude/skills/gitnexus/gitnexus-cli/SKILL.md