Skip to content

Add site cartridge path management commands#295

Merged
clavery merged 2 commits intomainfrom
feature/194-cartridge-paths
Mar 29, 2026
Merged

Add site cartridge path management commands#295
clavery merged 2 commits intomainfrom
feature/194-cartridge-paths

Conversation

@clavery
Copy link
Copy Markdown
Collaborator

@clavery clavery commented Mar 29, 2026

Summary

  • Add sites cartridges list|add|remove|set CLI commands and corresponding SDK operations (getCartridgePath, addCartridge, removeCartridge, setCartridgePath) for managing the ordered list of active cartridges on a site
  • Support Business Manager cartridge path via --bm flag (Sites-Site), which uses site archive import/export since OCAPI only supports reading for BM
  • Automatic fallback to site archive import/export when OCAPI direct permissions (/sites/*/cartridges) are unavailable, with actionable error messages when both paths fail
  • Default position for add is first; supports first, last, before, after with --target
  • Progress reporting via CartridgeUpdateOptions with log callback for phase messages and waitOptions.onProgress for job polling, consistent with job import/job export idiom

Closes #194

Test plan

  • b2c sites cartridges list --site-id <id> returns numbered cartridge path
  • b2c sites cartridges list --bm returns BM cartridge path
  • b2c sites cartridges add <name> --site-id <id> adds via OCAPI
  • b2c sites cartridges add <name> --bm adds via site archive import with progress output
  • b2c sites cartridges remove <name> --site-id <id> removes cartridge
  • b2c sites cartridges set "a:b:c" --bm replaces entire BM path
  • --json flag returns structured CartridgePathResult for all commands
  • Singular alias works (sites cartridge list)
  • OCAPI fallback triggers on 403 with informational messages
  • All tests pass: pnpm run test:agent

clavery added 2 commits March 29, 2026 16:02
Add `sites cartridges list|add|remove|set` commands with SDK operations
for managing the ordered list of active cartridges on a site. Includes
`--bm` flag for Business Manager support and automatic fallback to site
archive import/export when OCAPI permissions are unavailable.
@clavery clavery merged commit b7f78ca into main Mar 29, 2026
5 checks passed
@clavery clavery deleted the feature/194-cartridge-paths branch March 29, 2026 23:21
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.

OCAPI Cartridges Support

1 participant