docs: update README with installation instructions - #694
Conversation
There was a problem hiding this comment.
1 issue found across 1 file
Confidence score: 3/5
README.mddocuments 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 usepublic.ecr.aws/r3m4q3r9/qovery-clior 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
| Run the CLI without installing it locally: | ||
|
|
||
| ```sh | ||
| docker run ghcr.io/qovery/qovery-cli:latest help |
There was a problem hiding this comment.
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>
| docker run ghcr.io/qovery/qovery-cli:latest help | |
| docker run public.ecr.aws/r3m4q3r9/qovery-cli:latest help |
There was a problem hiding this comment.
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
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
Dockerwithout a local install. Previously only ECR images were published; now images are pushed to both ECR and GHCR, and the README points to GHCR.Homebrew,Scoop, andAUR.Dockerusage withghcr.io/qovery/qovery-cliand recommends pinning a version.ghcr.io/qovery/qovery-clialongside ECR, add an OCI source label, and grantpackages: writepermission.Written for commit edda44a. Summary will update on new commits.