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. 4a-4d require user confirmation; 4e (synthesis save) is applied automatically.

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.

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.1.0.tar.gz (63.2 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.1.0-py3-none-any.whl (36.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: llmwiki_cli-0.1.0.tar.gz
  • Upload date:
  • Size: 63.2 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.1.0.tar.gz
Algorithm Hash digest
SHA256 392b84a5ee166141c0b79b697adfc887f53ac004c4295c5642e79d28c9085a75
MD5 4f60364d8ec6283c4000750d2936f4ba
BLAKE2b-256 f335011e43fe4010877b01bd35e062a4aef7df63b897912830d388952d39c3cb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: llmwiki_cli-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 36.5 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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fa853e3688447e241cd2e481ed2ceaefb3d378c87ff3c31075b8f4738e20aba5
MD5 801ede964053f29e05cd829e6916a811
BLAKE2b-256 8cca98cf13cf06e8c2b080c582a22414b134ffc01e9dead885770b940ce6f1ab

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