Skip to content

docs: update README with installation instructions - #694

Merged
benjaminch merged 2 commits into
mainfrom
docs/improve-installation-doc
Aug 25, 2026
Merged

docs: update README with installation instructions#694
benjaminch merged 2 commits into
mainfrom
docs/improve-installation-doc

Conversation

@benjaminch

@benjaminch benjaminch commented Aug 25, 2026

Copy link
Copy Markdown
Collaborator

Summary by cubic

Adds platform-specific install instructions to the README and publishes the CLI image to GHCR, so users can install on any OS and run the CLI via Docker without a local install. Previously only ECR images were published; now images are pushed to both ECR and GHCR, and the README points to GHCR.

  • Adds a curl installer for Linux/macOS and documents a pinned release + checksum workflow for verification.
  • Documents installs via Homebrew, Scoop, and AUR.
  • Adds Docker usage with ghcr.io/qovery/qovery-cli and recommends pinning a version.
  • Adds a post-install verification step with the CLI version command.
  • Updates doc links and the logo URL.
  • Updates the release workflow to log in to GHCR, tag and push images to ghcr.io/qovery/qovery-cli alongside ECR, add an OCI source label, and grant packages: write permission.

Written for commit edda44a. Summary will update on new commits.

Review in cubic

@benjaminch benjaminch added documentation Improvements or additions to documentation improvement labels Aug 25, 2026

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 issue found across 1 file

Confidence score: 3/5

  • README.md documents a Docker image that is not published by the release workflow, so users following the instructions cannot pull or run it; update the documentation to use public.ecr.aws/r3m4q3r9/qovery-cli or publish the image to GHCR.
Prompt for AI agents (unresolved issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="README.md">

<violation number="1" location="README.md:68">
P2: The documented Docker image doesn't exist. The release workflow only pushes to Amazon ECR (`public.ecr.aws/r3m4q3r9/qovery-cli`), never to GitHub Container Registry (`ghcr.io`), so `docker run ghcr.io/qovery/qovery-cli:latest help` will fail to pull. Use `public.ecr.aws/r3m4q3r9/qovery-cli`, matching the existing Versions section.</violation>
</file>

Reply with feedback, questions, or to request a fix.

Fix all with cubic | Re-trigger cubic

Comment thread README.md
Comment thread README.md
Run the CLI without installing it locally:

```sh
docker run ghcr.io/qovery/qovery-cli:latest help

@cubic-dev-ai cubic-dev-ai Bot Aug 25, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The 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 (public.ecr.aws/r3m4q3r9/qovery-cli), never to GitHub Container Registry (ghcr.io), so docker run ghcr.io/qovery/qovery-cli:latest help will fail to pull. Use public.ecr.aws/r3m4q3r9/qovery-cli, matching the existing Versions section.

Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At README.md, line 68:

<comment>The documented Docker image doesn't exist. The release workflow only pushes to Amazon ECR (`public.ecr.aws/r3m4q3r9/qovery-cli`), never to GitHub Container Registry (`ghcr.io`), so `docker run ghcr.io/qovery/qovery-cli:latest help` will fail to pull. Use `public.ecr.aws/r3m4q3r9/qovery-cli`, matching the existing Versions section.</comment>

<file context>
@@ -1,12 +1,80 @@
+Run the CLI without installing it locally:
+
+```sh
+docker run ghcr.io/qovery/qovery-cli:latest help
+```
+
</file context>
Suggested change
docker run ghcr.io/qovery/qovery-cli:latest help
docker run public.ecr.aws/r3m4q3r9/qovery-cli:latest help
Fix with cubic

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All reported issues were addressed across 2 files (changes from recent commits).

Reply with feedback, questions, or to request a fix.

Fix all with cubic | Re-trigger cubic

Comment thread .github/workflows/release.yml
@benjaminch
benjaminch merged commit 34d5c8e into main Aug 25, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation improvement

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants