Skip to main content

Standalone CLI for llmwiki — entity-based knowledge wiki compiled from any directory of text files.

Project description

llmwiki-cli

English | 日本語

Standalone CLI for llmwiki, runnable outside of Claude Code.

Requirements

  • Python 3.12+
  • Claude Code installed and on PATH — the Agent SDK spawns the claude binary as a subprocess. Install via:
    npm install -g @anthropic-ai/claude-code
    
    or follow the native installer at https://claude.com/claude-code.

Authentication

Primary: CLAUDE_CODE_OAUTH_TOKEN (recommended).

claude setup-token
export CLAUDE_CODE_OAUTH_TOKEN=sk-ant-oat01-...

A one-year long-lived OAuth token that uses your Claude Pro / Max / Team / Enterprise subscription quota. No per-call API billing.

Fallback: ANTHROPIC_API_KEY (API billing) — issued at https://console.anthropic.com.

Resolution order: CLAUDE_CODE_OAUTH_TOKEN > ANTHROPIC_API_KEY.

Run

uvx (recommended, no install)

uvx llmwiki-cli lint
uvx llmwiki-cli ingest
uvx llmwiki-cli query "your question"
uvx llmwiki-cli docs "theme" -o out.md

Each run uses a fresh isolated environment. The first invocation resolves dependencies; subsequent runs start instantly from the uv cache.

uv run (as a project dependency)

For a project that declares llmwiki-cli in its pyproject.toml:

uv run llmwiki-cli lint

One-off usage without declaring the dependency:

uv run --with llmwiki-cli llmwiki-cli lint

Before publication / straight from the repo

Prior to PyPI release:

uvx --from . llmwiki-cli lint                                                  # local checkout
uvx --from git+https://github.com/ktrysmt/llmwiki-cli llmwiki-cli lint         # Git
uvx --from git+https://github.com/ktrysmt/llmwiki-cli@v0.1.0 llmwiki-cli lint  # pinned tag

Persistent install

uv tool install llmwiki-cli
# or
pipx install llmwiki-cli

Commands

llmwiki-cli ingest [path]                      # import + lint + fix pipeline
llmwiki-cli lint                               # read-only health check
llmwiki-cli query "question" [--write]         # natural-language query over the wiki
llmwiki-cli docs "theme" [-o out.md]           # single document
llmwiki-cli docs "theme A" "theme B" -o dir/   # multiple themes in parallel

--write on query enables the feedback loop: the LLM proposes relationship additions, new entities, contradiction flags, dormant promotions, and synthesis saves. All proposed items (4a-4e) are auto-applied without per-item confirmation.

Internals

Resolution order for the deterministic scripts (llmwiki-preprocess / llmwiki-makeindex / llmwiki-decay):

  1. Bundled inside the installed wheel at llmwiki_cli/resources/bin/
  2. PATH (when the llmwiki Claude Code plugin is installed)
  3. Repository bin/ (for editable dev checkouts)

Under uvx / uv run everything resolves via (1), so users do not need anything beyond the CLI itself (except claude).

The wiki page schema is bundled at llmwiki_cli/resources/schema.md and embedded into LLM system prompts for Phase 1 / 3 / 4 of ingest and for query --write.

Release

Build, publish, and release shortcuts are provided via Makefile. Requires UV_PUBLISH_TOKEN (from https://pypi.org/manage/account/token/) exported in the current shell.

make build                       # build wheel + sdist into dist/
make publish                     # build + upload to PyPI
make release VERSION=0.1.1       # bump pyproject.toml, commit, tag, publish, push
make tag VERSION=0.1.1           # git tag only (no publish)
make verify                      # sanity-check via uvx --no-cache
make clean                       # remove dist/
make help                        # list targets

make release aborts if the working tree is dirty. It edits pyproject.toml, creates a v<VERSION> tag, publishes to PyPI, and pushes both the commit and tag to origin.

Changelog

v0.2.0

  • ingest: added stats-based early-exit when there are no new/updated/missing files, no contradictions, and no decay candidates
  • ingest: added a synthesis quality check after Phase 1 that reviews the top 3 updated pages for bidirectional Relations and Source Files table correctness, and applies fixes in-place
  • ingest, lint, docs: now append a ## [YYYY-MM-DD] <cmd> | ... entry to .llmwiki/log.md at the end of each run
  • lint: expanded the system prompt to explicitly enumerate every report category (orphan, broken links, stale, uncovered, contradictions with urgency tiers, decay, promotion, cross-entity, contradiction stats, provenance gaps)
  • query --write: removed per-item confirmation — 4a–4e are all auto-applied (matches the updated plugin policy)

v0.1.0

  • Initial release: ingest, lint, query, docs commands
  • Auth via CLAUDE_CODE_OAUTH_TOKEN (preferred) or ANTHROPIC_API_KEY fallback
  • Deterministic scripts bundled into the wheel at llmwiki_cli/resources/bin/; schema embedded at llmwiki_cli/resources/schema.md

License

MIT

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

llmwiki_cli-0.2.0.tar.gz (66.8 kB view details)

Uploaded Source

Built Distribution

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

llmwiki_cli-0.2.0-py3-none-any.whl (38.9 kB view details)

Uploaded Python 3

File details

Details for the file llmwiki_cli-0.2.0.tar.gz.

File metadata

  • Download URL: llmwiki_cli-0.2.0.tar.gz
  • Upload date:
  • Size: 66.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.7 {"installer":{"name":"uv","version":"0.11.7","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 llmwiki_cli-0.2.0.tar.gz
Algorithm Hash digest
SHA256 2e767647895ba7e06716fe4d9c4486c14d95b2daa0f9d3926f9aa1afb7b1275c
MD5 af9d234fce0d898cb603c821784181af
BLAKE2b-256 6f63c11620e984866dda1b96cbb2c651edd72121bace844da9e03ac6862eafbd

See more details on using hashes here.

File details

Details for the file llmwiki_cli-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: llmwiki_cli-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 38.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.7 {"installer":{"name":"uv","version":"0.11.7","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 llmwiki_cli-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ff3a42b9d83495d79863653ce1cf1d1ed70b3982d991dbee7f15ff0bb64be188
MD5 eb6f59da1dae09002cf6518377678e2b
BLAKE2b-256 88c107d9f81466e5d3108f82b6035fd4ea6a77f7d7e3915babc6e739e6e920c6

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