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.68.tar.gz (558.4 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.68-py3-none-any.whl (570.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: chunksmith_cli-0.6.68.tar.gz
  • Upload date:
  • Size: 558.4 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.68.tar.gz
Algorithm Hash digest
SHA256 8c4b7d8ffe88fe67ddf9eb3e53d2465be746ade252c574722cab1972445d8119
MD5 6e5969384a481319e7e5c4c9995c1981
BLAKE2b-256 3b66a09883a5bf75f85a38326b93d7b0b549ff1273175406b575beef8bd5b7cc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: chunksmith_cli-0.6.68-py3-none-any.whl
  • Upload date:
  • Size: 570.9 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.68-py3-none-any.whl
Algorithm Hash digest
SHA256 2bed0bbcf9e3b7cfadcdcaee6b3ec83282fee8b3a82cb42fc4e399307a9e7896
MD5 23a1943d463c0694834a8bd89fc2507d
BLAKE2b-256 f7275fc3e50f42655c72f674493dc57314a5154459b4ee3df05a5c00fae6fa50

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