Fix cloud command documentation#2417
Open
arsalann wants to merge 2 commits into
Open
Conversation
arsalann
force-pushed
the
arsalann/review-cloud-command-docs
branch
from
July 20, 2026 13:47
a88351f to
9193d0f
Compare
arsalann
marked this pull request as ready for review
July 20, 2026 14:22
Contributor
Prompt To Fix All With AIFix the following 1 code review issue. Work through them one at a time, proposing concise fixes.
---
### Issue 1 of 1
docs/commands/cloud.md:354-357
**`diagnose` marks `--project-id` as required but the CLI auto-resolves it**
The new flag table lists `--project-id` as `(required)` for `diagnose`, but the implementation calls `resolveProjectID`, which auto-resolves to the single project when only one exists. Only `--pipeline` is unconditionally required. A user with a single project can omit `--project-id` successfully — labelling it required here will confuse them and diverges from how the same flag is described for `runs list`, where the auto-resolve path isn't available.
Reviews (1): Last reviewed commit: "Fix cloud command documentation" | Re-trigger Greptile |
Contributor
|
Reviews (2): Last reviewed commit: "Clarify diagnose project selection" | Re-trigger Greptile |
mustafa3rsan
approved these changes
Jul 20, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Correct the
bruin cloudcommand reference so its examples, flags, scopes, and documented subcommands match the current CLI.Why
Several documented commands omitted required flags, accepted unsupported flags, or described behavior the CLI does not support. This made otherwise copyable examples fail.
Impact
Users can rely on the Cloud command page for accurate command syntax and behavior.
Validation
make buildnpm run docs:build./node_modules/.bin/markdownlint-cli2 --no-globs docs/commands/cloud.mdgit diff --check