Skip to content

Commit 85f20fa

Browse files
docs: improve install discoverability and recommend pipx/uv (#8)
## Summary - Lead install instructions with `pipx`/`uv tool install` instead of bare `pip` — avoids `externally-managed-environment` errors on modern macOS/Linux - Add explicit callout that `dremio-client` is an unrelated package (LLMs were installing it instead of `dremio-cli`) - Update PyPI description and keywords for better LLM/search discoverability ## Context A non-dev user asked Claude Code to "find the dremio CLI and install it." Claude found `dremio-client` (wrong package), hit the externally-managed-environment error, struggled with PATH, then hit missing deps in the wrong package. None of these are bugs in `dremio-cli`, but we can prevent the confusion with better docs and metadata. ## Test plan - [ ] Verify README renders correctly on GitHub - [ ] Verify `pipx install dremio-cli` works on a clean macOS machine - [ ] Check PyPI description after next release shows the updated text 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent aa34152 commit 85f20fa

2 files changed

Lines changed: 14 additions & 5 deletions

File tree

README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,18 @@ Dremio Cloud has a powerful REST API and rich system tables, but no official CLI
3232

3333
### 1. Install
3434

35+
The package name is **`dremio-cli`** (not `dremio-client`, which is an unrelated third-party package).
36+
3537
```bash
36-
# Install from PyPI (recommended)
37-
pip install dremio-cli
38+
# Recommended — isolated install, no venv needed
39+
pipx install dremio-cli
3840

39-
# Or with uv
41+
# Or with uv (fast, also isolated)
4042
uv tool install dremio-cli
4143

44+
# Or with pip (requires a virtual environment on modern Python)
45+
pip install dremio-cli
46+
4247
# Or install from source
4348
git clone https://github.com/dremio/cli.git
4449
cd cli
@@ -48,6 +53,10 @@ uv tool install .
4853
uv sync
4954
```
5055

56+
> **Tip:** On macOS and recent Linux distros, `pip install` into the system Python is blocked
57+
> (`externally-managed-environment` error). Use `pipx` or `uv tool install` instead — they
58+
> automatically create an isolated environment for you.
59+
5160
After install, verify the binary is available:
5261

5362
```bash

pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[project]
22
name = "dremio-cli"
33
dynamic = ["version"]
4-
description = "Developer CLI for Dremio Cloud"
4+
description = "Official developer CLI for Dremio Cloud — install with: pipx install dremio-cli"
55
readme = "README.md"
66
requires-python = ">=3.11"
77
license = "Apache-2.0"
@@ -17,7 +17,7 @@ classifiers = [
1717
"Programming Language :: Python :: 3.13",
1818
"Topic :: Database",
1919
]
20-
keywords = ["dremio", "cli", "data-lake", "sql"]
20+
keywords = ["dremio", "dremio-cloud", "cli", "data-lake", "sql", "official"]
2121
dependencies = [
2222
"typer>=0.9",
2323
"httpx>=0.27",

0 commit comments

Comments
 (0)