fix: update CLI install command to use GitHub URL#47
Conversation
hydradb-cli is not yet published to PyPI. Use pip install from GitHub until the package is published. Signed-off-by: Vorflux AI <noreply@vorflux.com>
Greptile SummaryThis PR corrects the CLI install command to use a direct GitHub URL ( Confidence Score: 5/5Safe to merge — documentation-only change with correct pip VCS syntax and a helpful PyPI note. The only finding is a P2 style suggestion about pinning to a release tag; no logic errors, security issues, or broken functionality. No files require special attention. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[User wants to install hydradb-cli] --> B{PyPI published?}
B -- No --> C["pip install git+https://github.com/usecortex/hydradb-cli.git"]
B -- Yes --> D["pip install hydradb-cli"]
C --> E[hydradb login]
D --> E
E --> F[hydradb whoami]
Reviews (1): Last reviewed commit: "fix: update CLI install command to use G..." | Re-trigger Greptile |
| <Step title="Install the CLI"> | ||
| ```bash | ||
| pip install hydradb-cli | ||
| pip install git+https://github.com/usecortex/hydradb-cli.git |
There was a problem hiding this comment.
Consider pinning to a tag or commit
Installing from the default branch means users always pull the latest (potentially unstable) commit. For a published CLI doc, pointing to a tagged release (e.g. @v0.1.0) gives reproducible installs and prevents silent breakage if HEAD changes.
| pip install git+https://github.com/usecortex/hydradb-cli.git | |
| pip install git+https://github.com/usecortex/hydradb-cli.git@v0.1.0 |
(Replace v0.1.0 with the actual release tag once one exists; omit if HEAD is intentionally the canonical install target.)
hydradb-cli is not yet published to PyPI. Updates the install command from
pip install hydradb-clitopip install git+https://github.com/usecortex/hydradb-cli.gitwith a note thatpip install hydradb-cliwill work once published.Testing
pnpm mintlify validate— passed