docs(integrations): document the 'integration list --catalog' flag#3530
Merged
mnriem merged 2 commits intoJul 17, 2026
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the integrations reference documentation to make the specify integration list --catalog flag discoverable, aligning the docs with the CLI’s supported options.
Changes:
- Added an options table to the List Available Integrations section.
- Documented the
--catalogflag for browsing the full catalog (built-in + community).
Show a summary per file
| File | Description |
|---|---|
| docs/reference/integrations.md | Adds an option table to document specify integration list --catalog. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 1/1 changed files
- Comments generated: 1
- Review effort level: Low
'specify integration list' accepts a --catalog flag (integrations/_query_commands.py: typer.Option(False, "--catalog", ...)) that browses the full built-in + community catalog, but the Integrations reference documented no options for the list command. Add an option table for it, matching the style used by the sibling 'integration search' and 'integration catalog add' sections. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…y built-ins The --catalog row implied the default list already includes the full installed set; in fact 'integration list' iterates INTEGRATION_REGISTRY (built-ins) and marks installed status, so a community integration that is not built in only appears with --catalog. Reword the option and the intro sentence to say the default shows the built-in integrations and --catalog adds community ones. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
jawwad-ali
force-pushed
the
docs/integration-list-catalog-flag
branch
from
July 17, 2026 10:17
ba29b7f to
f32d10a
Compare
Collaborator
|
Thank you! |
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.
What
specify integration listaccepts a--catalogflag:…but the List Available Integrations section of
docs/reference/integrations.mddocumented no options, so the flag was undiscoverable from the docs (unlikeintegration searchandintegration catalog add, which both have option tables).Fix
Add a one-row option table documenting
--catalog, matching the style of the sibling command sections. Docs-only.Verification
src/specify_cli/integrations/_query_commands.py.markdownlint-cli2 docs/reference/integrations.md→ 0 errors;git diff --checkclean.🤖 Written with the assistance of Claude Code (AI). Gap self-found (flag present in code, absent from docs).