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.2.tar.gz (208.5 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.2-py3-none-any.whl (225.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: chunksmith_cli-0.6.2.tar.gz
  • Upload date:
  • Size: 208.5 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.2.tar.gz
Algorithm Hash digest
SHA256 affff8df2b3de8402bf235576a44fed4c0c8305419faff4edbaff10be4d82a09
MD5 70985aa30d83510fde55d4f332a333bf
BLAKE2b-256 791fc2133e5e0a2b0a66fbad2816de922fda81388c1fafac7293eb9d3616abad

See more details on using hashes here.

File details

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

File metadata

  • Download URL: chunksmith_cli-0.6.2-py3-none-any.whl
  • Upload date:
  • Size: 225.6 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 99fefa72530bdcc1522ffa93bc41b9289b7e15ac052ca0b7123b634f1581c5a8
MD5 211cfb4073a12daff41c97c2ee925495
BLAKE2b-256 8d9018a465ebe71b551133e1f826e72ab130af43468cc0b5c64bfcb790b7ffd5

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