Skip to content

command-patterns.md

Latest commit

 

History

History
116 lines (92 loc) · 5.73 KB

command-patterns.md

File metadata and controls

116 lines (92 loc) · 5.73 KB
Raw

Command Patterns

Use live manifest discovery before unfamiliar work:

compress doctor --json
compress sync --profile "$COMPRESS_PROFILE"
compress commands list --profile "$COMPRESS_PROFILE" --scope store --json
compress commands list --profile "$COMPRESS_PROFILE" --scope store --search setup --mutating --json
compress commands docs --profile "$COMPRESS_PROFILE" --scope store --plugin commerce-core

compress commands docs renders risk, confirmation, idempotency, dry-run support, and descriptions from the live manifest. Do not rely on stale command examples when the manifest can answer.

Products

compress store product list --profile my-store --json
compress store product get <product-id> --profile my-store --json
compress store product create --profile my-store --input product.json --idempotency-key <key> --dry-run --json
compress store product update <product-id> --profile my-store --input patch.json --idempotency-key <key> --dry-run --json
compress store product import --profile my-store --input products.json --idempotency-key <key> --dry-run --json

Orders

compress store order list --profile my-store --json
compress store order get <order-id> --profile my-store --json
compress store order note <order-id> --profile my-store --content "..." --idempotency-key <key> --dry-run --json
compress store order refund <order-id> --profile my-store --amount 1000 --reason "..." --idempotency-key <key> --dry-run --json

Refunds require exact human confirmation of order, amount, and reason.

Inventory

compress store inventory list --profile my-store --json
compress store inventory adjust <product-id> --profile my-store --mode adjust --adjustment -1 --reason "manual" --idempotency-key <key> --dry-run --json

Storefront Content

compress store profile get --profile my-store --json
compress store profile apply --profile my-store --input profile-patch.json --dry-run --idempotency-key profile-1 --json
compress store navigation get --profile my-store --json
compress store navigation apply --profile my-store --input navigation.json --dry-run --idempotency-key nav-1 --json
compress store studio module list --profile my-store --surface homepage --json
compress store studio module patch --profile my-store --surface homepage --module-id home-hero --input module-patch.json --dry-run --idempotency-key hero-1 --json
compress store policy list --profile my-store --json
compress store policy upsert --profile my-store --input policy.json --dry-run --idempotency-key policy-1 --json
compress store seo get --profile my-store --json
compress store seo apply --profile my-store --input seo.json --dry-run --idempotency-key seo-1 --json

Settings And Plugins

compress store settings export --profile my-store --json
compress store settings import --profile my-store --input settings.json --idempotency-key <key> --dry-run --json
compress store plugin list --profile my-store --json
compress store plugin enable <plugin> --profile my-store --idempotency-key <key> --dry-run --json
compress store plugin disable <plugin> --profile my-store --idempotency-key <key> --dry-run --json

Plugin disables and credential-related settings require explicit human confirmation.

Subscriptions, Bookings, Newsletters, And Coupons

compress store subscription plan list --profile my-store --json
compress store subscription product setup --profile my-store --input subscription-product.json --idempotency-key <key> --dry-run --json
compress store booking setup --profile my-store --input booking-service.json --idempotency-key <key> --dry-run --json
compress store newsletter signup apply --profile my-store --input newsletter-signup.json --idempotency-key <key> --dry-run --json
compress store newsletter campaign draft-upsert --profile my-store --input campaign.json --idempotency-key <key> --dry-run --json
compress store newsletter campaign send --profile my-store --input send.json --idempotency-key <key> --dry-run --json
compress store coupon draft create --profile my-store --input coupon.json --idempotency-key <key> --dry-run --json
compress store coupon active create --profile my-store --input coupon.json --idempotency-key <key> --dry-run --confirm "<coupon-code>" --json

Newsletter sends contact customers. Always run a dry-run first and confirm the campaign title plus audience count exactly as returned by the dry-run.

Chatbot And Jobs

compress store chatbot status --profile my-store --json
compress store chatbot test-message "How do I change my store name?" --profile my-store --dry-run --json
compress store chatbot knowledge sync --profile my-store --idempotency-key <key> --dry-run --json
compress store job get <job-id> --profile my-store --json
compress store job logs <job-id> --profile my-store --jsonl

Action Authority

Use Action Authority when the task is about the proposal lifecycle or when a direct mutating command returns ACTION_AUTHORITY_REQUIRED.

compress store action manifest --profile my-store --json
compress store action catalog --profile my-store --format markdown
compress store action dry-run <action-id> --profile my-store --input action-input.json --idempotency-key <key> --json
compress store action propose <action-id> --profile my-store --input action-input.json --idempotency-key <key> --json
compress store action proposal list --profile my-store --json
compress store action proposal get <proposal-id> --profile my-store --json
compress store action proposal execute <proposal-id> --profile my-store --confirmation-token <token> --confirm "<exact-echo>" --json
compress store action execution audit-link <execution-id> --profile my-store --json

Action commands call /api/v1/actions/* with CSRF protection and bearer auth. They do not bypass Action Authority policy.