Skip to main content

Global flags

These flags are available on all Shoplazza CLI commands.

FlagTypeDefaultDescription
--format <format>stringjsonOutput format: json, pretty, or table
--jq <expression>stringFilter JSON output using a jq expression
-q <expression>stringShorthand alias for --jq
--dry-runbooleanfalsePreview the HTTP request without executing it
--fields <fields>stringComma-separated fields for output projection (shortcuts only)
--help / -hbooleanShow help for the command

Examples

# Table output
shoplazza products list --format table

# Pretty print
shoplazza orders +search --format pretty

# Filter with jq
shoplazza products list --jq '.data.products[] | {id, title, price}'

# Dry run
shoplazza products create --data '{"product": {"title": "Test"}}' --dry-run

# Field projection (shortcuts)
shoplazza orders +search --fields "id,status,total_price" --format table