Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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: 8 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
github:
- jb-thery

# Optional funding platforms can be added later.
# open_collective:
# - mimir
# custom:
# - https://polar.sh/
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# Changelog

## 0.2.1 - 2026-06-28

- Add GitHub Sponsors funding metadata and document suggested sponsor tiers.
- Add maintainer positioning for Jean-Baptiste Thery and JCode Labs in the README.
- Make `kb init` and `kb install-skill` automatically keep `.kb/` and `.mimir/`
ignored by Git.

## 0.2.0 - 2026-06-28

- Rename public product branding to Mimir while keeping the JCode Labs npm scope.
Expand Down
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ and uses Ollama for local embeddings and answers.

Created by Jean-Baptiste Thery and published under the JCode Labs npm scope.

Built by Jean-Baptiste Thery, freelance full-stack/AI tooling engineer at JCode Labs.

## Open Source

Mimir is a public open-source project under the MIT License. It is designed to be
Expand All @@ -21,6 +23,20 @@ inspectable, forkable, and usable without a JCode Labs account.
Contributions are welcome through pull requests. Start with [`CONTRIBUTING.md`](./CONTRIBUTING.md).
Security reports should stay private and follow the policy in [`SECURITY.md`](./SECURITY.md).

## Sponsors

Mimir stays MIT open source. Sponsorship helps fund maintenance, issue triage,
documentation, and practical agent-workflow improvements.

Sponsor the project through [GitHub Sponsors](https://github.com/sponsors/jb-thery).

Suggested GitHub Sponsors tiers:

- EUR 5/month: support the project.
- EUR 15/month: active sponsor.
- EUR 49/month: priority on issues and questions.
- EUR 199/month: company sponsor and light advisory support.

## Status

Early public package. APIs may evolve before `1.0.0`.
Expand Down Expand Up @@ -161,8 +177,9 @@ your-project/
.kb/storage/ # generated LanceDB index
```

The package never ships project documents. `kb init` adds gitignore entries for `.kb/storage/`
and `private/**`.
The package never ships project documents. `kb init` adds gitignore entries for `.kb/`
and `private/**`, and `kb install-skill` keeps `.mimir/` ignored as generated local agent
state.

## Supported Files

Expand Down
3 changes: 3 additions & 0 deletions dist/gitignore.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
export declare const MIMIR_GITIGNORE_ENTRIES: readonly [".kb/", ".mimir/", "private/**", "!private/", "!private/README.md", "!private/**/", "!private/**/.gitkeep"];
export declare function ensureMimirGitignore(cwd?: string): Promise<boolean>;
//# sourceMappingURL=gitignore.d.ts.map
1 change: 1 addition & 0 deletions dist/gitignore.d.ts.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

34 changes: 34 additions & 0 deletions dist/gitignore.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions dist/gitignore.js.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion dist/init.d.ts.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 4 additions & 7 deletions dist/init.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion dist/init.js.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion dist/skill.d.ts.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

16 changes: 11 additions & 5 deletions dist/skill.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion dist/skill.js.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion dist/version.d.ts
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
export declare const VERSION = "0.2.0";
export declare const VERSION = "0.2.1";
//# sourceMappingURL=version.d.ts.map
2 changes: 1 addition & 1 deletion dist/version.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@jcode.labs/mimir",
"version": "0.2.0",
"version": "0.2.1",
"description": "Mimir: open-source local-first memory and retrieval for private project knowledge.",
"type": "module",
"license": "MIT",
Expand Down
3 changes: 3 additions & 0 deletions scripts/smoke.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,9 @@ try {
await runKb(["install-skill"], tempRoot)
const skill = await readFile(path.join(tempRoot, ".mimir", "skills", "mimir", "SKILL.md"), "utf8")
assertIncludes(skill, "name: mimir", "install-skill should copy the bundled skill")
const gitignore = await readFile(path.join(tempRoot, ".gitignore"), "utf8")
assertIncludes(gitignore, ".kb/", "init should ignore the Mimir config and index directory")
assertIncludes(gitignore, ".mimir/", "install-skill should ignore generated agent kit files")

await smokeMcp(tempRoot)
console.log("Smoke test passed.")
Expand Down
Loading
Loading