Skip to content

docs(integrations): update CLI commands to current flags - #3666

Open
rawsun007 wants to merge 2 commits into
chainloop-dev:mainfrom
rawsun007:docs-integration-cli-commands
Open

rawsun007 wants to merge 2 commits into
chainloop-dev:mainfrom
rawsun007:docs-integration-cli-commands

Conversation

@rawsun007

@rawsun007 rawsun007 commented Oct 20, 2026 •

Copy link
Copy Markdown

The integration docs (devel/integrations.md and the plugin READMEs) still show the commands from before #1046/#1051 moved integrations from IDs to names and #1515 made --project required on integration attached add. As written, every attach example fails with required flag(s) "project" not set, available describe --id fails with unknown flag: --id, and the smtp README still uses chainloop workflow integration attach, which no longer exists. The smtp registration example was also missing the required --name, and in devel/integrations.md a # comment line inside the oci-registry backslash continuation ended the command before its --opt lines.

This updates those commands to the current flags, with placeholders in the [name] style the READMEs already use. I ran each changed command against a CLI built from main: they all get past argument and flag validation and stop only at the connection to the control plane. The sample output tables in these docs are older than the commands (for example dependencytrack as an ID) and I left them as they are.

This was written with Claude Code and found by parsing every chainloop ... command in the repo's Markdown with the CLI's own cobra flag sets.

View guided diff

The integration docs still used the pre-2024 commands: describe and
attach by ID, a removed `workflow integration attach`, and attach
without the `--project` flag that is now required, so each example
fails flag validation. The smtp registration example was also missing
the required `--name`, and a comment inside the oci-registry
continuation ended the command early.

Assisted-by: Claude Code
Signed-off-by: Roshan Ramani <roshanramani.dev@gmail.com>
@chainloop-platform

chainloop-platform Bot commented Oct 20, 2026 •

Copy link
Copy Markdown
Contributor

PR validation — ✅ 3 passing

Status Policy Material Messages
✅ Passed pr-min-approvals pr-info -
✅ Passed pr-description-required pr-info -
✅ Passed pr-user-story-linked pr-info -

View attestation ↗

AI Session Checks — ⚠️ no AI session found

Missing AI Coding Sessions

This organization requires every PR to be backed by a Chainloop Trace AI coding session, and none was found for this one.

Please make sure the AI coding session evidence has been sent by the Chainloop CLI, or add the skip-ai-session label to this PR to bypass this check.

Learn more about Chainloop Trace.

Security Checks — ✅ 5 passing

✅ secret-scan

Status Policy Messages
✅ Passed secrets-detection -

✅ sast-scan

Status Policy Messages
✅ Passed cwe-top25 -
✅ Passed owasp-top10-2025 -
✅ Passed sast -
✅ Passed cwe-top26-40-cusp -
Scans not applied (3)
Scan Reason
vulnerability-scan no manifest/lockfile changed
github-actions-scan no workflow files changed
iac-scan no IaC files changed

View attestation ↗

Security context

✅ Nothing this change touches has a recorded security-fix history.

View in Chainloop ↗ · How this works ↗


Powered by Chainloop and Chainloop Trace

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

Copy link
Copy Markdown
Contributor

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 7 files

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

View guided diff | Re-trigger cubic

Comment thread app/controlplane/plugins/core/guac/v1/README.md
Comment thread devel/integrations.md Outdated
The guac README still said the attach command takes IDs, and the
attachment paragraph in devel/integrations.md was missing a word.

Assisted-by: Claude Code
Signed-off-by: Roshan Ramani <roshanramani.dev@gmail.com>
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