Update collections documentation with implementation details
- Mark collections CLI as fully implemented - Add admin management UI documentation - Update CLI command examples (cmdforge collections list/info/install) - Add API endpoint documentation - Include example output and usage instructions Co-Authored-By: Claude Opus 4.5 <[email protected]>
This commit is contained in:
+22
-5
@@ -353,16 +353,33 @@ Response:
|
||||
|
||||
```bash
|
||||
# List available collections
|
||||
cmdforge registry collections
|
||||
cmdforge collections list
|
||||
|
||||
# List in JSON format
|
||||
cmdforge collections list --json
|
||||
|
||||
# View collection details
|
||||
cmdforge registry collections text-processing-essentials
|
||||
cmdforge collections info text-processing-essentials
|
||||
|
||||
# View in JSON format
|
||||
cmdforge collections info text-processing-essentials --json
|
||||
|
||||
# Install all tools in a collection
|
||||
cmdforge registry install --collection text-processing-essentials
|
||||
cmdforge collections install text-processing-essentials
|
||||
|
||||
# Show what would be installed (dry run)
|
||||
cmdforge registry install --collection text-processing-essentials --dry-run
|
||||
# Install with pinned versions from collection
|
||||
cmdforge collections install text-processing-essentials --pinned
|
||||
```
|
||||
|
||||
### Admin Collections API
|
||||
|
||||
Collections are managed via the admin dashboard at `/dashboard/admin/collections`:
|
||||
|
||||
```
|
||||
GET /api/v1/admin/collections # List all collections (admin)
|
||||
POST /api/v1/admin/collections # Create collection (admin)
|
||||
PUT /api/v1/admin/collections/:name # Update collection (admin)
|
||||
DELETE /api/v1/admin/collections/:name # Delete collection (admin)
|
||||
```
|
||||
|
||||
**Schema compatibility note:** The current CmdForge config parser may reject unknown top-level keys like `deprecated`, `replacement`, and `registry`. Before implementing registry features:
|
||||
|
||||
Reference in New Issue
Block a user