Install

yaaa docs · Command reference

Command reference

Every yaaa command, argument, and option, generated from the CLI itself.

Docs menu
  1. Get started
  2. Buying
  3. Watches and restocks
  4. Alerts
  5. Your account
  6. Plans
  7. Settings
  8. Your agent
  9. Troubleshooting
  10. Updating and uninstalling
  11. Command reference
    1. Options for every command
    2. recovery-key
    3. init
    4. login
    5. shop
    6. logout
    7. whoami
    8. desk
    9. doctor
    10. plus
    11. products
    12. buy
    13. status
    14. cancel
    15. config
    16. watch
    17. restock
    18. alerts
    19. events
    20. notify
    21. mcp
    22. update

Options for every command

--version
output the version number
--json
print the exact API response as JSON (for agents)
--pretty
with --json, indent it for reading
--idempotency-key <key>
reuse the same key when retrying a command that changes state

Generated from the yaaa CLI. yaaa <command> --help shows the same in your terminal.

yaaa recovery-key

Get a recovery key for this account, shown in your terminal; --replace makes a new one (asks for the current one), and the old one stops working

yaaa recovery-key [options]
--replace
replace the existing key

yaaa init

Set up yaaa on this device: an anonymous account (no sign-up) and the skills for your agents

yaaa init [options]
--device-name <name>
shown on the web desk
--skills-dir <path>
install skills here instead of each agent’s default folder
--no-skills
skip installing skills
--restore [recovery-key]
use your existing account on this device, with the recovery key you saved: typed at the prompt (best), `-` for stdin, or as the value
--passkey
use your existing account on this device, approved with a passkey in the browser

yaaa login

Add a passkey (Touch ID, Face ID, or your phone) to sign in to this account on any device

yaaa login [options]
--no-open
only print the link

yaaa shop

Your Shop account (coming soon; yaaa works without it)

  • yaaa shop link: Coming soon: link your Shop account. yaaa works without it.

yaaa logout

Sign this device out of its yaaa account (forgets the account on this device)

yaaa logout

yaaa whoami

This device’s yaaa account

yaaa whoami

yaaa desk

Open the web desk, signed in to this account, in your browser (a one-time link)

yaaa desk [options]
--no-open
only print the link

yaaa doctor

Check the API, this device’s credentials, and which terminal agents are installed

yaaa doctor

yaaa plus

Start yaaa Plus: more watches and restocks, faster checks, longer watches. Opens Stripe Checkout, where you pay; it renews until you cancel

--yearly
pay yearly instead of monthly
--no-open
only print the link
  • yaaa plus manage: Manage yaaa Plus in Stripe’s billing portal: switch monthly or yearly, update the card, see invoices, or cancel
  • yaaa plus status: Your plan, your yaaa Plus subscription, and what’s in use

yaaa plus manage

Manage yaaa Plus in Stripe’s billing portal: switch monthly or yearly, update the card, see invoices, or cancel

yaaa plus manage [options]
--no-open
only print the link

yaaa plus status

Your plan, your yaaa Plus subscription, and what’s in use

yaaa plus status

yaaa products

Find products at stores that sell to agents

  • yaaa products search: Search by name, brand, or keywords, with optional filters
  • yaaa products similar: Products like this one (id, product page URL, or search words): alternatives, or something cheaper
  • yaaa products get: One product by id (prd_...), product page URL, or search words, with price and stock per variant

yaaa products similar

Products like this one (id, product page URL, or search words): alternatives, or something cheaper

yaaa products similar <product...> [options]
--limit <n>
how many results
--max <usd>
highest price
--min-rating <stars>
only products rated at least this, 0 to 5

yaaa products get

One product by id (prd_...), product page URL, or search words, with price and stock per variant

yaaa products get <product>

yaaa buy

Quote the total with tax and shipping, and get a confirm link that opens the store’s checkout

yaaa buy <product...> [options]
--variant <variant>
variant id or name, like "black" or "10.5"
--qty <n>
quantity
--max <usd>
refuse if the total is higher

yaaa status

Everything in flight, or one purchase by id

yaaa status [id]

yaaa cancel

Withdraw a confirm link that hasn’t been used

yaaa cancel <purchase_id>

yaaa config

Settings for this account

  • yaaa config limits: Show or set what your agent may spend. It asks before going over.
  • yaaa config prefs: Your shopping preferences on this device: sizes, budgets, brands, and where things ship
  • yaaa config images: Product images in this terminal: auto (when the terminal supports them), on, or off

yaaa config limits

Show or set what your agent may spend. It asks before going over.

yaaa config limits [options]
--per-purchase <usd>
most a single purchase may total
--monthly <usd>
most all purchases may total in a month

yaaa config prefs

Your shopping preferences on this device: sizes, budgets, brands, and where things ship

Examples:
  yaaa config prefs set size.shoes 10
  yaaa config prefs set budget.shoes 150
  yaaa config prefs set prefer-brands "Allbirds, Veja"
  yaaa config prefs set ships-to US
  yaaa config prefs unset size.shoes

The yaaa-advisor skill recommends from these. They stay on this device.

yaaa config prefs set

Set one preference, like size.shoes 10 or prefer-brands "Allbirds, Veja"

yaaa config prefs set <key> <value...>

yaaa config prefs unset

Remove one preference

yaaa config prefs unset <key>

yaaa config prefs clear

Remove all preferences on this device

yaaa config prefs clear

yaaa config images

Product images in this terminal: auto (when the terminal supports them), on, or off

yaaa config images [setting]
auto shows images in terminals with a graphics protocol (iTerm2, WezTerm, Kitty, Ghostty, Warp).
on also shows them where that isn't detected (VS Code, with terminal.integrated.enableImages).
off hides them, including macOS notification thumbnails. YAAA_IMAGES=0 or 1 overrides this.
Images never appear in --json or piped output.

yaaa watch

Price watches (a confirm link when a product hits your price) and filter watches (alerts for new matches to a search)

  • yaaa watch price: Watch a product (checked hourly for up to 30 days; every 15 minutes, up to 90 days, with yaaa Plus)
  • yaaa watch search: Watch a search across stores (checked every 12 hours for up to 30 days; every 3 hours, up to 90 days, with yaaa Plus): alerts for new matches, price drops, restocks
  • yaaa watch matches: What a filter watch has found (and you haven't dismissed), cheapest first
  • yaaa watch dismiss: Hide a product from a filter watch's matches; it won't alert again
  • yaaa watch list: Your price watches and filter watches
  • yaaa watch cancel: Stop a price watch (wch_...) or a filter watch (fwt_...)

yaaa watch price

Watch a product (checked hourly for up to 30 days; every 15 minutes, up to 90 days, with yaaa Plus)

yaaa watch price <product...> [options]
--below <usd>
alert at or below this price, in stock
--variant <variant>
only this variant
--until <date>
stop watching after this date (YYYY-MM-DD)

yaaa watch matches

What a filter watch has found (and you haven't dismissed), cheapest first

yaaa watch matches <watch_id>

yaaa watch dismiss

Hide a product from a filter watch's matches; it won't alert again

yaaa watch dismiss <watch_id> <product_id>

yaaa watch list

Your price watches and filter watches

yaaa watch list [options]
--all
include finished and cancelled watches

yaaa watch cancel

Stop a price watch (wch_...) or a filter watch (fwt_...)

yaaa watch cancel <watch_id>

yaaa restock

Reorder on a schedule: each run is quoted a day early and sends a confirm link

yaaa restock [product...] [options]

product…: product id, URL, or words; or one of: list, pause, resume, skip, cancel

--every <days>
every N days, like 14d
--monthly <day>
on this day of every month (1 to 28)
--qty <n>
quantity per run
--max <usd>
skip a run whose total is higher
--variant <variant>
variant id or name
--all
with `list`: include cancelled restocks

yaaa alerts

New alerts (watch hits, filter watch matches, restock runs, skipped runs) since you last looked

yaaa alerts [options]
--all
everything still open, not just new ones
--peek
don’t mark them seen

yaaa events

Your event stream: purchase.updated, watch.triggered, watch.matched, restock.run, restock.skipped

yaaa events [options]
--after-seq <seq>
only events after this sequence number
--follow
keep streaming as events happen (JSON lines with --json)

yaaa notify

Desktop notifications for watches and restocks

yaaa notify run

Run the notifier in the foreground (what the background service runs)

yaaa notify run [options]
--interval <seconds>
how often to check

yaaa notify test

Show a test notification

yaaa notify test

yaaa notify install

Run the notifier in the background at login (launchd on macOS, a systemd user unit on Linux)

yaaa notify install

yaaa notify status

Where alerts reach you: desktop notifications on this device, email, and Discord

yaaa notify status

yaaa notify uninstall

Turn off background desktop notifications

yaaa notify uninstall

yaaa notify email

Email alerts as a fallback channel: an address (confirmed by a link sent there), or "off"

yaaa notify email [address]

yaaa notify discord

Post alerts to a Discord channel: its webhook URL, or "off"

yaaa notify discord [webhook-url]
In Discord: channel settings → Integrations → Webhooks → New Webhook → Copy Webhook URL.
Use a private channel: anyone who can see it can open your confirm links.

yaaa mcp

Serve yaaa’s tools over MCP (stdio) for agents that prefer tool calls to a shell

yaaa mcp

yaaa update

Update yaaa to the latest version (or --to <version>); refreshes the skills and the notifier too

yaaa update [options]
--check
only say whether a newer version is out
--to <version>
install this version instead, newer or older