Skip to content

docs: improve install discoverability and recommend pipx/uv #8

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
rahim-bhojani merged 1 commit into from
Mar 26, 2026
Merged

docs: improve install discoverability and recommend pipx/uv #8

Show file tree
Hide file tree
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
15 changes: 12 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,18 @@ Dremio Cloud has a powerful REST API and rich system tables, but no official CLI

### 1. Install

The package name is **`dremio-cli`** (not `dremio-client`, which is an unrelated third-party package).

```bash
# Install from PyPI (recommended)
pip install dremio-cli
# Recommended — isolated install, no venv needed
pipx install dremio-cli

# Or with uv
# Or with uv (fast, also isolated)
uv tool install dremio-cli

# Or with pip (requires a virtual environment on modern Python)
pip install dremio-cli

# Or install from source
git clone https://github.com/dremio/cli.git
cd cli
Expand All @@ -48,6 +53,10 @@ uv tool install .
uv sync
```

> **Tip:** On macOS and recent Linux distros, `pip install` into the system Python is blocked
> (`externally-managed-environment` error). Use `pipx` or `uv tool install` instead — they
> automatically create an isolated environment for you.

After install, verify the binary is available:

```bash
Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[project]
name = "dremio-cli"
dynamic = ["version"]
description = "Developer CLI for Dremio Cloud"
description = "Official developer CLI for Dremio Cloud — install with: pipx install dremio-cli"
readme = "README.md"
requires-python = ">=3.11"
license = "Apache-2.0"
Expand All @@ -17,7 +17,7 @@ classifiers = [
"Programming Language :: Python :: 3.13",
"Topic :: Database",
]
keywords = ["dremio", "cli", "data-lake", "sql"]
keywords = ["dremio", "dremio-cloud", "cli", "data-lake", "sql", "official"]
dependencies = [
"typer>=0.9",
"httpx>=0.27",
Expand Down
Loading