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.9.tar.gz (218.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.9-py3-none-any.whl (234.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: chunksmith_cli-0.6.9.tar.gz
  • Upload date:
  • Size: 218.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.9.tar.gz
Algorithm Hash digest
SHA256 1f14267011d6e45c5cc7dc4a208579fac1bb0d5c314e1d2c88f6c810d21bd82a
MD5 cf2e52acc8c6264af72e38f0649e6b8a
BLAKE2b-256 c2459cd48bb6d3fdacc9a17bed2f08e862f617e889107551f0801bb6e6e6d551

See more details on using hashes here.

File details

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

File metadata

  • Download URL: chunksmith_cli-0.6.9-py3-none-any.whl
  • Upload date:
  • Size: 234.2 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.9-py3-none-any.whl
Algorithm Hash digest
SHA256 fb90bd0c4296b63a80ecc1bbbd4740634a95b2d50f6e3cdd5c649f94a773235c
MD5 f9b83a84edd86d74b2f686cad2bb2d15
BLAKE2b-256 b7336e35201dd79d4e231a5b88af1fdd1a38cc7325450bdba11c04ed2a6c2c69

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