-
Notifications
You must be signed in to change notification settings - Fork 27
docs: update README with installation instructions #694
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.
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,26 +1,84 @@ | ||||||
| <p align="center"> | ||||||
| <img alt="Qovery Logo" src="https://raw.githubusercontent.com/Qovery/public-resources/master/qovery%20logo%20horizontal%20without%20margin.png" /> | ||||||
| <img alt="Qovery Logo" src="https://www.qovery.com/logos/qovery-logo-black.svg" /> | ||||||
| </p> | ||||||
|
|
||||||
| [Qovery](https://www.qovery.com/) helps tech companies to accelerate and scale application development cycle with zero infrastructure management investment. | ||||||
|
|
||||||
| This repository is the code source of the Qovery CLI. | ||||||
|
|
||||||
| See our complete documentation [here](https://docs.qovery.com) to get started with Qovery. | ||||||
| See the [Qovery documentation](https://docs.qovery.com) to get started with Qovery. | ||||||
|
|
||||||
| ## Authentication | ||||||
| See the [Qovery CLI documentation](https://www.qovery.com/docs/cli/overview) to get started with the CLI and explore its commands. | ||||||
|
|
||||||
| You can use `qovery auth` to authenticate with the CLI or use `Q_CLI_ACCESS_TOKEN` (or `QOVERY_CLI_ACCESS_TOKEN`) environment variable to set your API token. | ||||||
| ## Installation | ||||||
|
|
||||||
| Choose the installation method for your platform. | ||||||
|
|
||||||
| ### Linux | ||||||
|
|
||||||
| Install the latest version on any Linux distribution: | ||||||
|
|
||||||
| ```sh | ||||||
| curl -s https://get.qovery.com | bash | ||||||
| ``` | ||||||
|
|
||||||
| For security-sensitive environments, install from a [pinned GitHub release](https://github.com/Qovery/qovery-cli/releases) and verify the downloaded archive against that release's `checksums.txt`. The convenience script does not perform an integrity check. | ||||||
|
|
||||||
| ### macOS | ||||||
|
|
||||||
| Install with Homebrew: | ||||||
|
|
||||||
| ```sh | ||||||
| brew tap Qovery/qovery-cli | ||||||
| brew install qovery-cli | ||||||
| ``` | ||||||
|
|
||||||
| Alternatively, use the installer script: | ||||||
|
|
||||||
| ```sh | ||||||
| curl -s https://get.qovery.com | bash | ||||||
| ``` | ||||||
|
|
||||||
| For a pinned, checksum-verified installation, use a [GitHub release](https://github.com/Qovery/qovery-cli/releases). | ||||||
|
|
||||||
| ### Windows | ||||||
|
|
||||||
| ## Versions | ||||||
| Install with [Scoop](https://scoop.sh/): | ||||||
|
|
||||||
| You can install the latest version of the CLI: | ||||||
| ```powershell | ||||||
| scoop bucket add qovery https://github.com/Qovery/scoop-qovery-cli | ||||||
| scoop install qovery-cli | ||||||
| ``` | ||||||
|
|
||||||
| You can also download a release archive from [GitHub Releases](https://github.com/Qovery/qovery-cli/releases) and add the extracted `qovery` executable to your `PATH`. | ||||||
|
|
||||||
| ### Arch Linux | ||||||
|
|
||||||
| The CLI is available through the AUR: | ||||||
|
|
||||||
| ```sh | ||||||
| yay qovery-cli | ||||||
| ``` | ||||||
|
|
||||||
| ### Docker | ||||||
|
|
||||||
| Run the CLI without installing it locally: | ||||||
|
|
||||||
| ```sh | ||||||
| docker run ghcr.io/qovery/qovery-cli:latest help | ||||||
|
cubic-dev-ai[bot] marked this conversation as resolved.
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. P2: The documented Docker image doesn't exist. The release workflow only pushes to Amazon ECR ( Prompt for AI agents
Suggested change
|
||||||
| ``` | ||||||
|
|
||||||
| Replace `latest` with a specific version when you need reproducible builds. | ||||||
|
|
||||||
| ### Verify the installation | ||||||
|
|
||||||
| ```sh | ||||||
| qovery version | ||||||
| ``` | ||||||
|
|
||||||
| - On Mac: with brew `brew install qovery-cli` | ||||||
| - On ArchLinux: with `yay qovery-cli` | ||||||
| - On Windows: with scoop `scoop install qovery-cli` | ||||||
| - On Docker: at the address `public.ecr.aws/r3m4q3r9/qovery-cli` | ||||||
| - From binary: <https://github.com/Qovery/qovery-cli/releases> | ||||||
| ## Authentication | ||||||
|
|
||||||
| You can use `qovery auth` to authenticate with the CLI or use `Q_CLI_ACCESS_TOKEN` (or `QOVERY_CLI_ACCESS_TOKEN`) environment variable to set your API token. | ||||||
|
|
||||||
| # Update deps | ||||||
|
|
||||||
|
|
||||||
Uh oh!
There was an error while loading. Please reload this page.