@yaaa-io/cli 0.1.12 → 0.1.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +122 -7
  2. package/dist/yaaa.mjs +123 -122
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -1,8 +1,19 @@
1
+ <p align="center"><a href="https://yaaa.io"><img src="https://raw.githubusercontent.com/yaaa-io/yaaa/main/assets/banner.png" alt="YAAA: your shopping agent, in your terminal" width="100%"></a></p>
2
+
3
+ <p align="center">
4
+ <a href="https://yaaa.io"><b>yaaa.io</b></a> ·
5
+ <a href="https://yaaa.io/docs/">Docs</a> ·
6
+ <a href="https://yaaa.io/docs/reference/">Command reference</a> ·
7
+ <a href="https://yaaa.io/docs/plans/">Plans</a> ·
8
+ <a href="https://discord.gg/RzukGnVBRA">Discord</a> ·
9
+ <a href="https://github.com/yaaa-io/yaaa">GitHub</a>
10
+ </p>
11
+
1
12
  # yaaa
2
13
 
3
14
  YAAA (Yet Another AI Agent), by [NxisAI](https://nxis.ai), lets the AI agent in your terminal buy from online stores at retail, in your name: right now, when a price drops, when something new fits a search, or on a schedule. Every purchase ends with a confirm link that opens the store's own checkout, where you pay the store directly. yaaa never touches your card.
4
15
 
5
- yaaa is in beta, for US-based Shopify stores that support agent checkout (UCP). Docs: [yaaa.io/docs](https://yaaa.io/docs/).
16
+ yaaa is in beta, for US-based Shopify stores that support agent checkout (UCP).
6
17
 
7
18
  ## Install
8
19
 
@@ -13,19 +24,123 @@ npm install -g @yaaa-io/cli
13
24
  yaaa init # an anonymous account (no sign-up), and the skills for your agents
14
25
  ```
15
26
 
16
- Update with `npm install -g @yaaa-io/cli@latest`. Nothing runs when the package installs; `yaaa init` is a step you run.
27
+ Update with `npm install -g @yaaa-io/cli@latest`. Nothing runs when the package installs: `yaaa init` is a step you run.
28
+
29
+ Other ways to install, each with the same release:
30
+
31
+ ```sh
32
+ curl -fsSL https://yaaa.io/install | sh # brings its own Node.js
33
+ brew install yaaa-io/tap/yaaa # Homebrew, on macOS and Linux
34
+ ```
35
+
36
+ ## Use it from your agent
37
+
38
+ `yaaa init` installs two skills into each terminal agent it finds (Claude Code, Hermes, and others): **yaaa-buyer** buys, watches prices and restocks, and **yaaa-advisor** recommends and compares. Then just ask, for example:
39
+
40
+ > find me trail running shoes under $120 and get a quote on the best one
41
+
42
+ > watch the Allbirds Tree Runners in size 10 and tell me if they drop below $90
43
+
44
+ Agents that prefer tool calls can use the same operations over MCP: `yaaa mcp`. Every command also takes `--json` for agents and scripts.
45
+
46
+ ## Commands
47
+
48
+ ### Get started
49
+
50
+ | Command | What it does |
51
+ | --- | --- |
52
+ | `yaaa init` | Set up yaaa on this device: an anonymous account (no sign-up) and the skills for your agents |
53
+ | `yaaa doctor` | Check the API, this device’s credentials, and which terminal agents are installed |
54
+ | `yaaa update` | Update yaaa to the latest version (or --to <version>); refreshes the skills and the notifier too |
17
55
 
18
- Without Node, use the installer, which brings its own: `curl -fsSL https://yaaa.io/install | sh`.
56
+ ### Shop
19
57
 
20
- Then ask your agent, for example Claude Code: "find me trail running shoes under $120 and get a quote on the best one". [Getting started](https://yaaa.io/docs/) covers the rest, and the [command reference](https://yaaa.io/docs/reference/) lists every command.
58
+ | Command | What it does |
59
+ | --- | --- |
60
+ | `yaaa products` | Find products at stores that sell to agents |
61
+ | `yaaa products search <query...>` | Search by name, brand, or keywords, with optional filters |
62
+ | `yaaa products similar <product...>` | Products like this one (id, product page URL, or search words): alternatives, or something cheaper |
63
+ | `yaaa products get <product>` | One product by id (prd_...), product page URL, or search words, with price and stock per variant |
64
+ | `yaaa buy <product...>` | Quote the total with tax and shipping, and get a confirm link that opens the store’s checkout |
65
+ | `yaaa status [id]` | Everything in flight, or one purchase by id |
66
+ | `yaaa cancel <purchase_id>` | Withdraw a confirm link that hasn’t been used |
67
+
68
+ ### Watch prices and restocks
69
+
70
+ | Command | What it does |
71
+ | --- | --- |
72
+ | `yaaa watch` | Price watches (a confirm link when a product hits your price) and filter watches (alerts for new matches to a search) |
73
+ | `yaaa watch price <product...>` | Watch a product (checked hourly for up to 30 days; every 15 minutes, up to 90 days, with yaaa Plus) |
74
+ | `yaaa watch search <query...>` | 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 |
75
+ | `yaaa watch matches <watch_id>` | What a filter watch has found (and you haven't dismissed), cheapest first |
76
+ | `yaaa watch dismiss <watch_id> <product_id>` | Hide a product from a filter watch's matches; it won't alert again |
77
+ | `yaaa watch list` | Your price watches and filter watches |
78
+ | `yaaa watch cancel <watch_id>` | Stop a price watch (wch_...) or a filter watch (fwt_...) |
79
+ | `yaaa restock [product...]` | Reorder on a schedule: each run is quoted a day early and sends a confirm link |
80
+
81
+ ### Alerts and notifications
82
+
83
+ | Command | What it does |
84
+ | --- | --- |
85
+ | `yaaa alerts` | New alerts (watch hits, filter watch matches, restock runs, skipped runs) since you last looked |
86
+ | `yaaa events` | Your event stream: purchase.updated, watch.triggered, watch.matched, restock.run, restock.skipped |
87
+ | `yaaa notify` | Desktop notifications for watches and restocks |
88
+ | `yaaa notify run` | Run the notifier in the foreground (what the background service runs) |
89
+ | `yaaa notify test` | Show a test notification |
90
+ | `yaaa notify install` | Run the notifier in the background at login (launchd on macOS, a systemd user unit on Linux) |
91
+ | `yaaa notify status` | Where alerts reach you: desktop notifications on this device, email, and Discord |
92
+ | `yaaa notify uninstall` | Turn off background desktop notifications |
93
+ | `yaaa notify email [address]` | Email alerts as a fallback channel: an address (confirmed by a link sent there), or "off" |
94
+ | `yaaa notify discord [webhook-url]` | Post alerts to a Discord channel: its webhook URL, or "off" |
95
+
96
+ ### Your account
97
+
98
+ | Command | What it does |
99
+ | --- | --- |
100
+ | `yaaa whoami` | This device’s yaaa account |
101
+ | `yaaa login` | Add a passkey (Touch ID, Face ID, or your phone) to sign in to this account on any device |
102
+ | `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 |
103
+ | `yaaa desk` | Open the web desk, signed in to this account, in your browser (a one-time link) |
104
+ | `yaaa shop` | Your Shop account (coming soon; yaaa works without it) |
105
+ | `yaaa shop link` | Coming soon: link your Shop account. yaaa works without it. |
106
+ | `yaaa plus` | Start yaaa Plus: more watches and restocks, faster checks, longer watches. Opens Stripe Checkout, where you pay; it renews until you cancel |
107
+ | `yaaa plus manage` | Manage yaaa Plus in Stripe’s billing portal: switch monthly or yearly, update the card, see invoices, or cancel |
108
+ | `yaaa plus status` | Your plan, your yaaa Plus subscription, and what’s in use |
109
+ | `yaaa logout` | Sign this device out of its yaaa account (forgets the account on this device) |
110
+ | `yaaa config` | Settings for this account |
111
+ | `yaaa config limits` | Show or set what your agent may spend. It asks before going over. |
112
+ | `yaaa config prefs` | Your shopping preferences on this device: sizes, budgets, brands, and where things ship |
113
+ | `yaaa config prefs set <key> <value...>` | Set one preference, like size.shoes 10 or prefer-brands "Allbirds, Veja" |
114
+ | `yaaa config prefs unset <key>` | Remove one preference |
115
+ | `yaaa config prefs clear` | Remove all preferences on this device |
116
+ | `yaaa config images [setting]` | Product images in this terminal: auto (when the terminal supports them), on, or off |
117
+
118
+ ### For agents
119
+
120
+ | Command | What it does |
121
+ | --- | --- |
122
+ | `yaaa mcp` | Serve yaaa’s tools over MCP (stdio) for agents that prefer tool calls to a shell |
123
+
124
+ ### More
125
+
126
+ | Command | What it does |
127
+ | --- | --- |
128
+ | `yaaa sessions` | Devices, desk sessions, agent tokens and connected apps signed in to this account |
129
+ | `yaaa sessions revoke <session_id>` | Sign a device out, or revoke an agent token or app, at once |
130
+
131
+ Every option, with examples: [yaaa.io/docs/reference](https://yaaa.io/docs/reference/), or `yaaa <command> --help`.
21
132
 
22
133
  ## Where this package comes from
23
134
 
24
- Each version is built and published from the tagged commit in [yaaa-io/yaaa](https://github.com/yaaa-io/yaaa) by its publish workflow, with [npm provenance](https://docs.npmjs.com/generating-provenance-statements): the version's page on npmjs.com links to that commit and workflow run. Check your install with `npm audit signatures`.
135
+ Each version is built from the tagged commit in [yaaa-io/yaaa](https://github.com/yaaa-io/yaaa) and published by its publish workflow with [npm provenance](https://docs.npmjs.com/generating-provenance-statements): the version's page on npmjs.com links to that commit and workflow run. Check your install with `npm audit signatures`.
136
+
137
+ ## Privacy
138
+
139
+ yaaa sends your searches, quotes, watches and account to api.yaaa.io, checks yaaa.io for updates, and collects no telemetry or analytics. The [GitHub README](https://github.com/yaaa-io/yaaa#what-yaaa-sends-and-where) has the details; see also the [Privacy Policy](https://yaaa.io/privacy/) and [Terms](https://yaaa.io/terms/).
25
140
 
26
- ## Security
141
+ ## Help and security
27
142
 
28
- Report vulnerabilities privately through [GitHub](https://github.com/yaaa-io/yaaa/security/advisories/new), not in public issues. See [SECURITY.md](https://github.com/yaaa-io/yaaa/blob/main/SECURITY.md).
143
+ Questions and bugs: [Discord](https://discord.gg/RzukGnVBRA) or [GitHub issues](https://github.com/yaaa-io/yaaa/issues). Report vulnerabilities privately through [GitHub](https://github.com/yaaa-io/yaaa/security/advisories/new), not in public issues.
29
144
 
30
145
  ## License
31
146