docs: document integration catalog subcommands#3206
Open
Quratulain-bilal wants to merge 2 commits into
Open
Conversation
the integration reference omits the 'specify integration catalog' subcommand group (list/add/remove) that exists in code, while the extension, preset, and workflow references all document their catalog equivalents. add a catalog management section matching that structure.
Contributor
There was a problem hiding this comment.
Pull request overview
Adds missing documentation for the specify integration catalog subcommand group so the integrations reference matches the CLI’s existing catalog-management capabilities.
Changes:
- Documented
specify integration catalog list/add/remove. - Documented catalog resolution order (env → project → user → built-in), consistent with the integration catalog stack behavior.
Show a summary per file
| File | Description |
|---|---|
| docs/reference/integrations.md | Adds a new “Catalog Management” section for integration catalog list/add/remove and resolution order. |
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: 2
- Review effort level: Low
|
|
||
| ## Catalog Management | ||
|
|
||
| Integration catalogs control where `search` and `install` look for integrations. Catalogs are checked in priority order. |
mnriem
requested changes
Jun 29, 2026
mnriem
left a comment
mnriem
left a comment
Collaborator
There was a problem hiding this comment.
Please address Copilot feedback
- catalogs are consulted by the discovery commands (search/info), not install; install resolves from the built-in registry - 'catalog list' shows project sources as removable only when configured, otherwise active sources are non-removable
Contributor
Author
|
both addressed in fb697be: changed the intro to say the discovery commands (search/info) consult catalogs, since install resolves from the built-in registry, not the catalog stack |
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.
closes #3205
docs/reference/integrations.mddid not mention thecatalogsubcommand group at all, even though it is registered in code (src/specify_cli/__init__.py:1277) and the extension/preset/workflow references all document their catalog equivalents.this adds a Catalog Management section covering:
specify integration catalog list(__init__.py:2556)specify integration catalog add <url> [--name](__init__.py:2611)specify integration catalog remove <index>(__init__.py:2643)SPECKIT_INTEGRATION_CATALOG_URL-> project -> user -> built-in), matching the code insrc/specify_cli/integrations/catalog.pystructure mirrors the existing Catalog Management section in
docs/reference/workflows.md. docs-only change, no code touched. separate from #3174 (which covers search/info/scaffold).note: i used an ai assistant to help investigate and write this up.