Skip to content

docs: document Mimir gitignore automation #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jb-thery merged 1 commit into from
Jun 28, 2026
Merged

docs: document Mimir gitignore automation #14

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@
- The package is open source under the MIT License unless the user explicitly changes it.
- This package must stay reusable across repositories. Resolve project data from the
caller's working directory or explicit config, not from the package installation path.
- `kb init` and `kb install-skill` must keep generated local Mimir state ignored in target
repositories. By default, add `.kb/`, `.mimir/`, and private raw-document paths to the
target repository `.gitignore`.
- Use Context7 before changing dependencies or public APIs that rely on external libraries.
- Run `pnpm validate` before opening a release pull request or publishing. It covers
Biome, TypeScript, Vitest, build output, production CLI/MCP smoke tests, and npm package
Expand All @@ -26,5 +29,8 @@
local LanceDB table.
- `src/query.ts` performs vector search and local Ollama answer synthesis.
- `src/mcp.ts` exposes Mimir as an MCP stdio server for agents.
- `src/gitignore.ts` owns target-repository `.gitignore` entries for local generated Mimir
state.
- `skills/mimir/SKILL.md` is the bundled portable agent skill.
- `.kb/storage/` and project `private/` folders are user data and must not be committed.
- `.kb/`, `.mimir/`, and project `private/` folders are local user data or generated agent
state in target repositories and must not be committed.
Loading