Skip to content

Fix cloud command documentation#2417

Open
arsalann wants to merge 2 commits into
mainfrom
arsalann/review-cloud-command-docs
Open

Fix cloud command documentation#2417
arsalann wants to merge 2 commits into
mainfrom
arsalann/review-cloud-command-docs

Conversation

@arsalann

Copy link
Copy Markdown
Contributor

Summary

Correct the bruin cloud command reference so its examples, flags, scopes, and documented subcommands match the current CLI.

  • Fix invalid run, pipeline, instance, glossary, and agent command examples.
  • Document all agent create, read, update, and prompt operations.
  • Use generic placeholders in the project-list output example.

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 build
  • npm run docs:build
  • ./node_modules/.bin/markdownlint-cli2 --no-globs docs/commands/cloud.md
  • git diff --check

@arsalann
arsalann force-pushed the arsalann/review-cloud-command-docs branch from a88351f to 9193d0f Compare July 20, 2026 13:47
@arsalann
arsalann marked this pull request as ready for review July 20, 2026 14:22
@greptile-apps

greptile-apps Bot commented Jul 20, 2026

Copy link
Copy Markdown
Contributor
Prompt To Fix All With AI
Fix 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

Comment thread docs/commands/cloud.md Outdated
@greptile-apps

greptile-apps Bot commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

Reviews (2): Last reviewed commit: "Clarify diagnose project selection" | Re-trigger Greptile

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants