crumbs-cli 0.3.0__tar.gz → 0.3.1__tar.gz

{crumbs_cli-0.3.0 → crumbs_cli-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: crumbs-cli
-Version: 0.3.0
+Version: 0.3.1
 Summary: Local, token-efficient cross-repo context for LLMs. CLI + MCP server.
 Author: crumbs
 License: MIT
@@ -46,10 +46,15 @@ can open *just that slice* of a file rather than the whole thing.
 
 ## Install
 
+The distribution is named `crumbs-cli`; it provides the `crumbs` command.
+
 ```bash
-pip install -e .        # provides the `crumbs` command
-# or run without installing:
-python3 -m crumbs --help
+pipx install crumbs-cli       # isolated, on your PATH (recommended)
+# or, no install at all:
+uvx --from crumbs-cli crumbs --help
+# or, from a clone:
+pip install -e .              # dev install
+python3 -m crumbs --help      # run without installing
 ```
 
 ## Usage
@@ -66,6 +71,39 @@ crumbs remove my-web                       # drop a repo from the index
 
 A repo can be referenced by name, id, or path.
 
+## Use with Claude Code (MCP)
+
+crumbs ships an MCP server (`crumbs mcp`) so an MCP host — Claude Code, Claude
+Desktop, or any MCP client — can call it as native tools. It speaks the MCP wire
+protocol over stdio with **zero dependencies** (no SDK).
+
+**One-command install (Claude Code plugin):**
+
+```shell
+/plugin marketplace add crumbs1505/crumbs
+/plugin install crumbs@crumbs
+```
+
+This bundles the MCP server and a skill; repo paths are auto-indexed on first
+use. See [`plugin/`](plugin/) for details.
+
+**Manual registration** (e.g. in a project `.mcp.json` or your Claude Code config):
+
+```jsonc
+{
+  "mcpServers": {
+    "crumbs": { "command": "uvx", "args": ["--from", "crumbs-cli", "crumbs", "mcp"] }
+  }
+}
+```
+
+`uvx` fetches and runs crumbs on demand, so nothing needs to be installed first.
+(If you installed via `pipx`, use `"command": "crumbs", "args": ["mcp"]` instead.)
+
+The server exposes five model-controlled tools — `crumbs_map`, `crumbs_search`,
+`crumbs_context`, `crumbs_index`, `crumbs_list` — and auto-indexes a repo path on
+first use, so there is no manual setup step.
+
 ## Workflow with Claude
 
 1. `crumbs index` the repos you work across (once, or on a `crumbs refresh` cron).
@@ -105,6 +143,25 @@ safely.
 python3 -m unittest discover -s tests -v
 ```
 
+## Releasing
+
+Releases are published to [PyPI](https://pypi.org/project/crumbs-cli/) automatically by
+CI ([`.github/workflows/publish.yml`](.github/workflows/publish.yml)) whenever a version
+tag is pushed. To cut a release:
+
+1. Bump the version in **all three** places: `pyproject.toml`, `crumbs/__init__.py`,
+   and `plugin/.claude-plugin/plugin.json` (keep them in sync).
+2. Commit the bump and push to `main`.
+3. Tag and push it:
+
+   ```bash
+   git tag v0.3.1 && git push origin v0.3.1
+   ```
+
+CI then builds the sdist + wheel, runs `twine check`, and publishes to PyPI via
+[Trusted Publishing](https://docs.pypi.org/trusted-publishers/) (OIDC — no token stored
+in the repo). PyPI versions are immutable, so every release needs a new version number.
+
 ## License
 
 MIT

{crumbs_cli-0.3.0 → crumbs_cli-0.3.1}/README.md

@@ -22,10 +22,15 @@ can open *just that slice* of a file rather than the whole thing.
 
 ## Install
 
+The distribution is named `crumbs-cli`; it provides the `crumbs` command.
+
 ```bash
-pip install -e .        # provides the `crumbs` command
-# or run without installing:
-python3 -m crumbs --help
+pipx install crumbs-cli       # isolated, on your PATH (recommended)
+# or, no install at all:
+uvx --from crumbs-cli crumbs --help
+# or, from a clone:
+pip install -e .              # dev install
+python3 -m crumbs --help      # run without installing
 ```
 
 ## Usage
@@ -42,6 +47,39 @@ crumbs remove my-web                       # drop a repo from the index
 
 A repo can be referenced by name, id, or path.
 
+## Use with Claude Code (MCP)
+
+crumbs ships an MCP server (`crumbs mcp`) so an MCP host — Claude Code, Claude
+Desktop, or any MCP client — can call it as native tools. It speaks the MCP wire
+protocol over stdio with **zero dependencies** (no SDK).
+
+**One-command install (Claude Code plugin):**
+
+```shell
+/plugin marketplace add crumbs1505/crumbs
+/plugin install crumbs@crumbs
+```
+
+This bundles the MCP server and a skill; repo paths are auto-indexed on first
+use. See [`plugin/`](plugin/) for details.
+
+**Manual registration** (e.g. in a project `.mcp.json` or your Claude Code config):
+
+```jsonc
+{
+  "mcpServers": {
+    "crumbs": { "command": "uvx", "args": ["--from", "crumbs-cli", "crumbs", "mcp"] }
+  }
+}
+```
+
+`uvx` fetches and runs crumbs on demand, so nothing needs to be installed first.
+(If you installed via `pipx`, use `"command": "crumbs", "args": ["mcp"]` instead.)
+
+The server exposes five model-controlled tools — `crumbs_map`, `crumbs_search`,
+`crumbs_context`, `crumbs_index`, `crumbs_list` — and auto-indexes a repo path on
+first use, so there is no manual setup step.
+
 ## Workflow with Claude
 
 1. `crumbs index` the repos you work across (once, or on a `crumbs refresh` cron).
@@ -81,6 +119,25 @@ safely.
 python3 -m unittest discover -s tests -v
 ```
 
+## Releasing
+
+Releases are published to [PyPI](https://pypi.org/project/crumbs-cli/) automatically by
+CI ([`.github/workflows/publish.yml`](.github/workflows/publish.yml)) whenever a version
+tag is pushed. To cut a release:
+
+1. Bump the version in **all three** places: `pyproject.toml`, `crumbs/__init__.py`,
+   and `plugin/.claude-plugin/plugin.json` (keep them in sync).
+2. Commit the bump and push to `main`.
+3. Tag and push it:
+
+   ```bash
+   git tag v0.3.1 && git push origin v0.3.1
+   ```
+
+CI then builds the sdist + wheel, runs `twine check`, and publishes to PyPI via
+[Trusted Publishing](https://docs.pypi.org/trusted-publishers/) (OIDC — no token stored
+in the repo). PyPI versions are immutable, so every release needs a new version number.
+
 ## License
 
 MIT

{crumbs_cli-0.3.0 → crumbs_cli-0.3.1}/crumbs/__init__.py

@@ -6,4 +6,4 @@ crumbs to understand many repos at once without reading -- and paying tokens for
 -- the entire source tree.
 """
 
-__version__ = "0.3.0"
+__version__ = "0.3.1"

{crumbs_cli-0.3.0 → crumbs_cli-0.3.1}/crumbs_cli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: crumbs-cli
-Version: 0.3.0
+Version: 0.3.1
 Summary: Local, token-efficient cross-repo context for LLMs. CLI + MCP server.
 Author: crumbs
 License: MIT
@@ -46,10 +46,15 @@ can open *just that slice* of a file rather than the whole thing.
 
 ## Install
 
+The distribution is named `crumbs-cli`; it provides the `crumbs` command.
+
 ```bash
-pip install -e .        # provides the `crumbs` command
-# or run without installing:
-python3 -m crumbs --help
+pipx install crumbs-cli       # isolated, on your PATH (recommended)
+# or, no install at all:
+uvx --from crumbs-cli crumbs --help
+# or, from a clone:
+pip install -e .              # dev install
+python3 -m crumbs --help      # run without installing
 ```
 
 ## Usage
@@ -66,6 +71,39 @@ crumbs remove my-web                       # drop a repo from the index
 
 A repo can be referenced by name, id, or path.
 
+## Use with Claude Code (MCP)
+
+crumbs ships an MCP server (`crumbs mcp`) so an MCP host — Claude Code, Claude
+Desktop, or any MCP client — can call it as native tools. It speaks the MCP wire
+protocol over stdio with **zero dependencies** (no SDK).
+
+**One-command install (Claude Code plugin):**
+
+```shell
+/plugin marketplace add crumbs1505/crumbs
+/plugin install crumbs@crumbs
+```
+
+This bundles the MCP server and a skill; repo paths are auto-indexed on first
+use. See [`plugin/`](plugin/) for details.
+
+**Manual registration** (e.g. in a project `.mcp.json` or your Claude Code config):
+
+```jsonc
+{
+  "mcpServers": {
+    "crumbs": { "command": "uvx", "args": ["--from", "crumbs-cli", "crumbs", "mcp"] }
+  }
+}
+```
+
+`uvx` fetches and runs crumbs on demand, so nothing needs to be installed first.
+(If you installed via `pipx`, use `"command": "crumbs", "args": ["mcp"]` instead.)
+
+The server exposes five model-controlled tools — `crumbs_map`, `crumbs_search`,
+`crumbs_context`, `crumbs_index`, `crumbs_list` — and auto-indexes a repo path on
+first use, so there is no manual setup step.
+
 ## Workflow with Claude
 
 1. `crumbs index` the repos you work across (once, or on a `crumbs refresh` cron).
@@ -105,6 +143,25 @@ safely.
 python3 -m unittest discover -s tests -v
 ```
 
+## Releasing
+
+Releases are published to [PyPI](https://pypi.org/project/crumbs-cli/) automatically by
+CI ([`.github/workflows/publish.yml`](.github/workflows/publish.yml)) whenever a version
+tag is pushed. To cut a release:
+
+1. Bump the version in **all three** places: `pyproject.toml`, `crumbs/__init__.py`,
+   and `plugin/.claude-plugin/plugin.json` (keep them in sync).
+2. Commit the bump and push to `main`.
+3. Tag and push it:
+
+   ```bash
+   git tag v0.3.1 && git push origin v0.3.1
+   ```
+
+CI then builds the sdist + wheel, runs `twine check`, and publishes to PyPI via
+[Trusted Publishing](https://docs.pypi.org/trusted-publishers/) (OIDC — no token stored
+in the repo). PyPI versions are immutable, so every release needs a new version number.
+
 ## License
 
 MIT

{crumbs_cli-0.3.0 → crumbs_cli-0.3.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "crumbs-cli"
-version = "0.3.0"
+version = "0.3.1"
 description = "Local, token-efficient cross-repo context for LLMs. CLI + MCP server."
 readme = "README.md"
 requires-python = ">=3.8"