Swiggy CLI

swiggy-cli

swiggy wraps the three official Swiggy MCP servers behind one stable JSON contract. This skill is the entry point; the task skills (swiggy-search, swiggy-cart, swiggy-checkout, swiggy-pay, swiggy-dineout-booking, swiggy-track, swiggy-address) assume everything here.

Always

1. Run every command with --json --no-interactive. stdout is then exactly one JSON object and the CLI never blocks on a prompt. Human mode prints tables and spinners you would have to parse.
2. Read ok, then branch on error.code, never on error.message. Codes are a stable contract; messages change upstream.
3. Never add --yes on your own. --yes is the user's consent to a destructive tool (orders, bookings, cart flush, address delete). Exit code 7 means "ask the human, then re-run with --yes".
4. Never retry an order-placing command after an error. place_food_order, checkout, book_table are not idempotent; a retry can double-order. Check orders/status first.
5. Never run bare swiggy, swiggy app or swiggy shell. They open interactive sessions that wait for keypresses and never return. If a harness might run swiggy with no arguments, set SWIGGY_NO_SHELL=1.
6. Resolve addressId before Food/Instamart calls (swiggy <server> addresses --json) or set it once with swiggy profile set default defaultAddressId <id>. In machine mode the CLI refuses to guess an address (exit 2).

Envelope

{ "ok": true, "server": "food", "tool": "search_restaurants", "data": { ...tool payload... },
  "meta": { "profile": "default", "message": "…", "rateLimit": { "limit": 70, "remaining": 61 }, "payment": {…} } }
{ "ok": false, "error": { "code": "AUTH_REQUIRED", "message": "…", "hint": "…", "details": {} } }

data is the Swiggy tool's own data (the {success,data,message} wrapper is already removed). Swiggy's human message is in meta.message. --raw returns the untouched MCP result.

Exit code → what to do

Servers and discovery

swiggy servers --json                       # food · instamart (alias im) · dineout, 51 tools total
swiggy tools food --json                    # live tools/list (needs auth); --offline for the bundled catalog
swiggy schema food search_menu --json       # live JSON Schema for one tool
swiggy call food search_menu --input '{"addressId":"<id>","query":"dosa"}' --json   # any tool, any args
swiggy docs reference/food/search_menu      # official docs page as Markdown

Prefer the ergonomic verbs (swiggy food search -q …) when one exists — they already use the documented camelCase parameter names. Use call for anything else; pass parameters exactly as swiggy schema reports them.

Do not use the CLI when

• The question is general knowledge ("does Swiggy deliver in Pune?"). It needs a real account and makes live calls.
• The user has not consented to spending money and the task would place an order.

Auth check pattern

swiggy auth status --json | jq -r '.data.servers[] | select(.authenticated|not) | .server'

Non-empty output → stop and ask the user to run swiggy auth init. The flow is browser-based; an agent cannot complete it.

Full command list: references/commands.md.