Skip to main content

Koinome CLI: create and maintain provider-independent, agent-readable markdown corpora.

Project description

Koinome

Koinome is a local-first, plain-Markdown system for creating and maintaining a personal knowledge corpus for a person and their AI agents, with a deterministic validation gate.

Koinome is the product and tooling. A corpus is a portable, governed body of knowledge maintained by an individual and usable by that individual and their authorised AI agents. The koinome command creates and maintains corpora.

Koinome currently provides a complete local-first corpus for individual use.

The individual corpus and its local tooling are free and open-source and are intended to remain so.

Current scope

The current Koinome release manages individual corpora, one corpus at a time. Cross-corpus sharing, transfer, combination, and federation are not implemented.

Free and open-source commitment

Koinome for individual use is a complete local-first product, not a limited edition of a hosted service. The individual corpus format, local tooling, validation, agent workflows, imports, exports, synthesis, migration, synchronisation, backup, and recovery are free and open-source and are intended to remain so.

You can create, maintain, and use local corpora without a Koinome account, subscription, or hosted service.

The problem

AI agents are amnesiac. Every session starts from zero, so context, decisions, and durable facts evaporate between sessions.

Judge any fix with the turn-it-off test: delete the tooling. With Koinome, delete every script and the corpus still works — notes open in any editor, git still diffs them, grep still finds them.

Memory corruption compounds quietly. For work knowledge, decisions, and governance records, the rule is absolute: nothing rewrites authoritative knowledge while you sleep.

The idea

The files are the product. Three commitments follow:

  1. Open standards only. CommonMark, YAML frontmatter, git, and todo.txt. Any human or agent can read a corpus with no adapter.
  2. Governed, not free-form. Deterministic validation and an optional git hook enforce the corpus contract. AI assists around the gate, never inside it.
  3. Authored, not compiled. Derived synthesis pages cite sources and pass the same gate as authored notes.

Guarantees

  1. Every note opens as plain text with no Koinome tooling installed.
  2. Validation is deterministic. No model, no network, no server.
  3. AI assists around the gate, never inside it. With every agent offline you can still read, write, validate, and commit.
  4. No Koinome process rewrites your notes unattended. The optional scheduled job is git sync only.
  5. Derived pages cite their sources. The validator rejects synthesis without provenance.
  6. Sensitive boundaries are physical. Keep sensitive material in a separate private corpus on a path no agent reaches.

Quick start

# run in place, no install
./koinome-cli new

# or install the command
pipx install .        # or: uv tool install .
koinome new

Interactive, or fully scriptable:

koinome new --name my-work --path ~/my-work

Or pass domains when the layout is already known:

koinome new --name my-work --path ~/my-work \
  --domain 10-projects=projects \
  --domain 20-governance=governance

This creates the corpus, installs the git hook, and sets up shared folders. Point your agent at it and run the koinome-init skill to finish setup. Requires Python 3.10+ and PyYAML.

End-to-end individual workflow

  1. Installuv tool install . or run ./koinome-cli.
  2. Create a corpuskoinome new --name my-corpus --path ~/my-corpus.
  3. Connect an agent — open the corpus in Claude Code, Codex, Gemini CLI, or Cursor; run koinome-init.
  4. Author or import — add notes, import exports with koinome seed, or distill seeds with koinome-distill-seeds.
  5. Validatekoinome doctor ~/my-corpus or python3 .scripts/validate_corpus.py --all inside the corpus.
  6. Retrieve and synthesise — use MOCs, grep, and koinome-synthesize for provenance-backed synthesis.
  7. Synchronise — commit and push with git; optional koinome_sync.py for automated sync.
  8. Upgrade safelykoinome upgrade ~/my-corpus refreshes managed tooling without touching your notes.
  9. Recover — roll back from .koinome/backups/ or git history; validation failures block bad commits.
  10. Remove tooling — delete Koinome scripts; your Markdown and git history remain.

Commands

command what it does
koinome new Create a new corpus
koinome seed Normalise a provider export to an import staging area
koinome doctor CORPUS Validate a corpus and refresh navigation maps
koinome check CORPUS Read-only conformance check (CI-safe)
koinome upgrade CORPUS Upgrade Koinome-managed tooling without modifying user-authored knowledge

See docs/USAGE.md for full reference.

Migrating from AuxMem

If you have an existing AuxMem folder, run koinome upgrade — see docs/MIGRATION.md.

Licence

MIT — see LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

koinome-0.0.0a1.tar.gz (115.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

koinome-0.0.0a1-py3-none-any.whl (118.0 kB view details)

Uploaded Python 3

File details

Details for the file koinome-0.0.0a1.tar.gz.

File metadata

  • Download URL: koinome-0.0.0a1.tar.gz
  • Upload date:
  • Size: 115.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.28 {"installer":{"name":"uv","version":"0.11.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for koinome-0.0.0a1.tar.gz
Algorithm Hash digest
SHA256 f16ba64e4000875d4dcb56ef7cebc40c425c4e40534049c4c64ab7f39230dc28
MD5 b86d3d47bd3e06ccd0256c57ea505904
BLAKE2b-256 09d50f2c10402e572b9a84d916d0bf55d567321f91e85a4df9dfc56ef74f1773

See more details on using hashes here.

File details

Details for the file koinome-0.0.0a1-py3-none-any.whl.

File metadata

  • Download URL: koinome-0.0.0a1-py3-none-any.whl
  • Upload date:
  • Size: 118.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.28 {"installer":{"name":"uv","version":"0.11.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for koinome-0.0.0a1-py3-none-any.whl
Algorithm Hash digest
SHA256 efd1bced4580f80338462fc57a6309834d699090d0d6a22670173d64a04561e5
MD5 215161e59e784e1276ed3a048d44625e
BLAKE2b-256 e90d0acb1a87a115d21240f7af19ae1427588940871bcd23770db0f0a8ea5c7f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page