diff --git a/CLAUDE.md b/CLAUDE.md index ee76b51..8f2298e 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -6,7 +6,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co - **Editable install:** `pip install -e .` - **Run the CLI locally:** `python -m coinhunter --help` -- **Install for end users:** `./scripts/install_local.sh` (standard `pip install -e .` wrapper) +- **Install for end users:** `pipx install coinhunter` (recommended) or `./scripts/install_local.sh` for local editable install. - **Tests:** There is no test suite yet. The README lists next priorities as adding pytest coverage for runtime paths, state manager, and trigger analyzer. - **Lint / type-check:** Not configured yet. diff --git a/README.md b/README.md index 2b83f7f..3a3ce56 100644 --- a/README.md +++ b/README.md @@ -89,8 +89,10 @@ src/coinhunter/ ### From PyPI (recommended) +`coinhunter` is a standalone CLI application. Use [pipx](https://pypa.github.io/pipx/) to install it in an isolated environment: + ```bash -pip install coinhunter +pipx install coinhunter ``` This installs the latest stable release and creates the `coinhunter` console script entry point. @@ -102,6 +104,8 @@ coinhunter --help coinhunter --version ``` +> On newer Linux distributions, installing directly into the system Python with `pip install coinhunter` will fail with `externally-managed-environment`. Use `pipx` or a virtual environment instead. + ### Development install (editable) If you're working on this repo locally: