Skip to main content

ChunkSmith CLI — modular indexing, storage, and document Q&A.

Project description

chunksmith-cli (Python)

PyPI package chunksmith-cli v0.6.0 — modular Rich terminal for ChunkSmith indexing, storage, and document Q&A.

Part of the ChunkSmith monorepo (packages/chunksmith-cli).

What's new in 0.6.0

  • Minimal core installpip install chunksmith-cli installs only the CLI shell + chunksmith-core

  • Modular extras — pick pipelines and features at install time

  • chunksmith install — interactive extra picker (runs pip/uv for you)

  • Dynamic menus — only shows modes for installed packages

  • Slash commands/exit, /back, /revert at any prompt (also without /)

  • Stepped wizards/revert rewinds to the previous configure/indexing step

Install profiles

| Command | What you get |

|---------|----------------|

| pip install chunksmith-cli | Core CLI: configure, doctor, install, View saved JSON |

| pip install "chunksmith-cli[unstructured]" --pre | + Unstructured pipeline |

| pip install "chunksmith-cli[pageindex]" | + PageIndexer |

| pip install "chunksmith-cli[online]" | + Mongo/S3 adapters |

| pip install "chunksmith-cli[agent]" | + Document Q&A |

| pip install "chunksmith-cli[indexing]" --pre | Both indexing pipelines |

| pip install "chunksmith-cli[all]==0.6.0" --pre | Full product |

After a minimal install:

chunksmith install    # pick extras interactively

chunksmith configure  # LLM + storage wizard

chunksmith doctor     # verify env + installed packages

chunksmith            # main menu (modes depend on installed extras)

Migration from 0.5.x

pip install --upgrade "chunksmith-cli[all]==0.6.0" --pre

# or

uv tool install "chunksmith-cli[all]==0.6.0" --prerelease=allow --force

Package layout (loose coupling)

| Package | Extra | Enables |

|---------|-------|---------|

| chunksmith-core | (base) | configure, doctor, view |

| chunksmith-multimodal | [unstructured] | Unstructured pipeline |

| chunksmith-pageindex | [pageindex] | PageIndexer |

| chunksmith-adapters | [online] | Mongo + S3 storage |

| chunksmith-agent | [agent] | Document Q&A |

Navigation commands

At any text prompt or yes/no menu:

| Command | Action |

|---------|--------|

| /exit or exit | Quit CLI immediately |

| /back or back | Return to main menu |

| /revert or revert | Re-edit previous wizard step |

Environment variables

LLM (LiteLLM gateway)

| Variable | Purpose |

|----------|---------|

| CHUNKSMITH_LLM_MODEL | e.g. azure/gpt-4o, openai/gpt-4o |

| API_KEY | Provider API key |

| API_BASE | Custom endpoint (Azure / proxy) |

| API_VERSION | Azure API version |

Storage

| Variable | Purpose |

|----------|---------|

| CHUNKSMITH_STORAGE_MODE | auto (default), local, or online |

| CHUNKSMITH_LOCAL_DATA_DIR | Override local data root |

Development

cd ChunkSmith

uv sync

uv run chunksmith

Tests

cd ChunkSmith

uv run pytest packages/chunksmith-cli/tests -q

Publish to PyPI (maintainers)

From ChunkSmith repo root, in dependency order:

$pkgs = @(

  "packages\chunksmith-core",

  "packages\chunksmith-multimodal",

  "packages\chunksmith-pageindex",

  "packages\chunksmith-adapters",

  "packages\chunksmith-agent",

  "packages\chunksmith-cli"

)

foreach ($p in $pkgs) { Push-Location $p; uv build; uv publish .\dist\*0.6.0*; Pop-Location }

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

chunksmith_cli-0.6.16.tar.gz (225.7 kB view details)

Uploaded Source

Built Distribution

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

chunksmith_cli-0.6.16-py3-none-any.whl (239.3 kB view details)

Uploaded Python 3

File details

Details for the file chunksmith_cli-0.6.16.tar.gz.

File metadata

  • Download URL: chunksmith_cli-0.6.16.tar.gz
  • Upload date:
  • Size: 225.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.13 {"installer":{"name":"uv","version":"0.9.13"},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for chunksmith_cli-0.6.16.tar.gz
Algorithm Hash digest
SHA256 0a616db58af077e8d95491ae8d7c86be289fff326b56e40fcfe20fda859739e9
MD5 8a9d7aa710e704d503f47facc9d92a83
BLAKE2b-256 91eca897a8539fa43e0e09cd4a32157f987e654bf98648694c0d2a6b40afc065

See more details on using hashes here.

File details

Details for the file chunksmith_cli-0.6.16-py3-none-any.whl.

File metadata

  • Download URL: chunksmith_cli-0.6.16-py3-none-any.whl
  • Upload date:
  • Size: 239.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.13 {"installer":{"name":"uv","version":"0.9.13"},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for chunksmith_cli-0.6.16-py3-none-any.whl
Algorithm Hash digest
SHA256 87fff549a3250d71f70aaf13686fc704f7604ae4a463ff1f8fc75a256342c151
MD5 b1d3efb6603b2cf36ec2c79ac182797a
BLAKE2b-256 9b12228a97abdadfa7eefe879b409c9dc32ec2a93a3d2f2de0fb2f0c1b011853

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