Skip to content

docs: show how to combine install extras #75

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
joy-software merged 1 commit into from
Jun 7, 2026
Merged

docs: show how to combine install extras #75

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,11 +57,16 @@ uv pip install -e . # or: pip install -e .
Optional extras (none are required; the core install is lean and works on Python 3.11 through 3.14):

```bash
pip install cgh[langs] # C# and Ruby parsers (tree-sitter grammars)
pip install cgh[lsp] # precise cross-file Python call resolution (jedi)
pip install cgh[kuzu] # the legacy Kuzu graph backend (DuckDB is the default)
pip install "cgh[langs]" # C# and Ruby parsers (tree-sitter grammars)
pip install "cgh[lsp]" # precise cross-file Python call resolution (jedi)
pip install "cgh[kuzu]" # the legacy Kuzu graph backend (DuckDB is the default)

# Combine extras in one bracket, comma-separated:
pip install "cgh[langs,lsp]"
```

Quote the package spec (`"cgh[...]"`) so zsh and bash do not try to glob the brackets. The same form works with `pipx install`, `uv tool install`, `uv pip install`, and from a source checkout: `pip install -e ".[langs,lsp]"`.

```bash
cgh --version
cgh init # initialize in any project
Expand Down