clishop 1.0.1 → 1.1.1

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.
package/LICENSE CHANGED
@@ -1,216 +1,21 @@
1
- The MCP project is undergoing a licensing transition from the MIT License to the Apache License, Version 2.0 ("Apache-2.0"). All new code and specification contributions to the project are licensed under Apache-2.0. Documentation contributions (excluding specifications) are licensed under CC-BY-4.0.
2
-
3
- Contributions for which relicensing consent has been obtained are licensed under Apache-2.0. Contributions made by authors who originally licensed their work under the MIT License and who have not yet granted explicit permission to relicense remain licensed under the MIT License.
4
-
5
- No rights beyond those granted by the applicable original license are conveyed for such contributions.
6
-
7
- ---
8
-
9
- Apache License
10
- Version 2.0, January 2004
11
- http://www.apache.org/licenses/
12
-
13
- TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
14
-
15
- 1. Definitions.
16
-
17
- "License" shall mean the terms and conditions for use, reproduction,
18
- and distribution as defined by Sections 1 through 9 of this document.
19
-
20
- "Licensor" shall mean the copyright owner or entity authorized by
21
- the copyright owner that is granting the License.
22
-
23
- "Legal Entity" shall mean the union of the acting entity and all
24
- other entities that control, are controlled by, or are under common
25
- control with that entity. For the purposes of this definition,
26
- "control" means (i) the power, direct or indirect, to cause the
27
- direction or management of such entity, whether by contract or
28
- otherwise, or (ii) ownership of fifty percent (50%) or more of the
29
- outstanding shares, or (iii) beneficial ownership of such entity.
30
-
31
- "You" (or "Your") shall mean an individual or Legal Entity
32
- exercising permissions granted by this License.
33
-
34
- "Source" form shall mean the preferred form for making modifications,
35
- including but not limited to software source code, documentation
36
- source, and configuration files.
37
-
38
- "Object" form shall mean any form resulting from mechanical
39
- transformation or translation of a Source form, including but
40
- not limited to compiled object code, generated documentation,
41
- and conversions to other media types.
42
-
43
- "Work" shall mean the work of authorship, whether in Source or
44
- Object form, made available under the License, as indicated by a
45
- copyright notice that is included in or attached to the work
46
- (an example is provided in the Appendix below).
47
-
48
- "Derivative Works" shall mean any work, whether in Source or Object
49
- form, that is based on (or derived from) the Work and for which the
50
- editorial revisions, annotations, elaborations, or other modifications
51
- represent, as a whole, an original work of authorship. For the purposes
52
- of this License, Derivative Works shall not include works that remain
53
- separable from, or merely link (or bind by name) to the interfaces of,
54
- the Work and Derivative Works thereof.
55
-
56
- "Contribution" shall mean any work of authorship, including
57
- the original version of the Work and any modifications or additions
58
- to that Work or Derivative Works thereof, that is intentionally
59
- submitted to the Licensor for inclusion in the Work by the copyright
60
- owner or by an individual or Legal Entity authorized to submit on behalf
61
- of the copyright owner. For the purposes of this definition, "submitted"
62
- means any form of electronic, verbal, or written communication sent
63
- to the Licensor or its representatives, including but not limited to
64
- communication on electronic mailing lists, source code control systems,
65
- and issue tracking systems that are managed by, or on behalf of, the
66
- Licensor for the purpose of discussing and improving the Work, but
67
- excluding communication that is conspicuously marked or otherwise
68
- designated in writing by the copyright owner as "Not a Contribution."
69
-
70
- "Contributor" shall mean Licensor and any individual or Legal Entity
71
- on behalf of whom a Contribution has been received by Licensor and
72
- subsequently incorporated within the Work.
73
-
74
- 2. Grant of Copyright License. Subject to the terms and conditions of
75
- this License, each Contributor hereby grants to You a perpetual,
76
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
- copyright license to reproduce, prepare Derivative Works of,
78
- publicly display, publicly perform, sublicense, and distribute the
79
- Work and such Derivative Works in Source or Object form.
80
-
81
- 3. Grant of Patent License. Subject to the terms and conditions of
82
- this License, each Contributor hereby grants to You a perpetual,
83
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
84
- (except as stated in this section) patent license to make, have made,
85
- use, offer to sell, sell, import, and otherwise transfer the Work,
86
- where such license applies only to those patent claims licensable
87
- by such Contributor that are necessarily infringed by their
88
- Contribution(s) alone or by combination of their Contribution(s)
89
- with the Work to which such Contribution(s) was submitted. If You
90
- institute patent litigation against any entity (including a
91
- cross-claim or counterclaim in a lawsuit) alleging that the Work
92
- or a Contribution incorporated within the Work constitutes direct
93
- or contributory patent infringement, then any patent licenses
94
- granted to You under this License for that Work shall terminate
95
- as of the date such litigation is filed.
96
-
97
- 4. Redistribution. You may reproduce and distribute copies of the
98
- Work or Derivative Works thereof in any medium, with or without
99
- modifications, and in Source or Object form, provided that You
100
- meet the following conditions:
101
-
102
- (a) You must give any other recipients of the Work or
103
- Derivative Works a copy of this License; and
104
-
105
- (b) You must cause any modified files to carry prominent notices
106
- stating that You changed the files; and
107
-
108
- (c) You must retain, in the Source form of any Derivative Works
109
- that You distribute, all copyright, patent, trademark, and
110
- attribution notices from the Source form of the Work,
111
- excluding those notices that do not pertain to any part of
112
- the Derivative Works; and
113
-
114
- (d) If the Work includes a "NOTICE" text file as part of its
115
- distribution, then any Derivative Works that You distribute must
116
- include a readable copy of the attribution notices contained
117
- within such NOTICE file, excluding those notices that do not
118
- pertain to any part of the Derivative Works, in at least one
119
- of the following places: within a NOTICE text file distributed
120
- as part of the Derivative Works; within the Source form or
121
- documentation, if provided along with the Derivative Works; or,
122
- within a display generated by the Derivative Works, if and
123
- wherever such third-party notices normally appear. The contents
124
- of the NOTICE file are for informational purposes only and
125
- do not modify the License. You may add Your own attribution
126
- notices within Derivative Works that You distribute, alongside
127
- or as an addendum to the NOTICE text from the Work, provided
128
- that such additional attribution notices cannot be construed
129
- as modifying the License.
130
-
131
- You may add Your own copyright statement to Your modifications and
132
- may provide additional or different license terms and conditions
133
- for use, reproduction, or distribution of Your modifications, or
134
- for any such Derivative Works as a whole, provided Your use,
135
- reproduction, and distribution of the Work otherwise complies with
136
- the conditions stated in this License.
137
-
138
- 5. Submission of Contributions. Unless You explicitly state otherwise,
139
- any Contribution intentionally submitted for inclusion in the Work
140
- by You to the Licensor shall be under the terms and conditions of
141
- this License, without any additional terms or conditions.
142
- Notwithstanding the above, nothing herein shall supersede or modify
143
- the terms of any separate license agreement you may have executed
144
- with Licensor regarding such Contributions.
145
-
146
- 6. Trademarks. This License does not grant permission to use the trade
147
- names, trademarks, service marks, or product names of the Licensor,
148
- except as required for reasonable and customary use in describing the
149
- origin of the Work and reproducing the content of the NOTICE file.
150
-
151
- 7. Disclaimer of Warranty. Unless required by applicable law or
152
- agreed to in writing, Licensor provides the Work (and each
153
- Contributor provides its Contributions) on an "AS IS" BASIS,
154
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
155
- implied, including, without limitation, any warranties or conditions
156
- of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
157
- PARTICULAR PURPOSE. You are solely responsible for determining the
158
- appropriateness of using or redistributing the Work and assume any
159
- risks associated with Your exercise of permissions under this License.
160
-
161
- 8. Limitation of Liability. In no event and under no legal theory,
162
- whether in tort (including negligence), contract, or otherwise,
163
- unless required by applicable law (such as deliberate and grossly
164
- negligent acts) or agreed to in writing, shall any Contributor be
165
- liable to You for damages, including any direct, indirect, special,
166
- incidental, or consequential damages of any character arising as a
167
- result of this License or out of the use or inability to use the
168
- Work (including but not limited to damages for loss of goodwill,
169
- work stoppage, computer failure or malfunction, or any and all
170
- other commercial damages or losses), even if such Contributor
171
- has been advised of the possibility of such damages.
172
-
173
- 9. Accepting Warranty or Additional Liability. While redistributing
174
- the Work or Derivative Works thereof, You may choose to offer,
175
- and charge a fee for, acceptance of support, warranty, indemnity,
176
- or other liability obligations and/or rights consistent with this
177
- License. However, in accepting such obligations, You may act only
178
- on Your own behalf and on Your sole responsibility, not on behalf
179
- of any other Contributor, and only if You agree to indemnify,
180
- defend, and hold each Contributor harmless for any liability
181
- incurred by, or claims asserted against, such Contributor by reason
182
- of your accepting any such warranty or additional liability.
183
-
184
- END OF TERMS AND CONDITIONS
185
-
186
- ---
187
-
188
- MIT License
189
-
190
- Copyright (c) 2024-2025 Model Context Protocol a Series of LF Projects, LLC.
191
-
192
- Permission is hereby granted, free of charge, to any person obtaining a copy
193
- of this software and associated documentation files (the "Software"), to deal
194
- in the Software without restriction, including without limitation the rights
195
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
196
- copies of the Software, and to permit persons to whom the Software is
197
- furnished to do so, subject to the following conditions:
198
-
199
- The above copyright notice and this permission notice shall be included in all
200
- copies or substantial portions of the Software.
201
-
202
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
203
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
204
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
205
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
206
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
207
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
208
- SOFTWARE.
209
-
210
- ---
211
-
212
- Creative Commons Attribution 4.0 International (CC-BY-4.0)
213
-
214
- Documentation in this project (excluding specifications) is licensed under
215
- CC-BY-4.0. See https://creativecommons.org/licenses/by/4.0/legalcode for
216
- the full license text.
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Davoox
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,18 +1,19 @@
1
1
  <p align="center">
2
2
  <h1 align="center">CLISHOP</h1>
3
3
  <p align="center">
4
- <strong>An open-source CLI for AI agents (and humans) to search, compare, and buy products — all from the terminal.</strong>
4
+ <strong>Order anything from your terminal. Built for AI agents and humans.</strong>
5
5
  </p>
6
6
  <p align="center">
7
- <a href="#quick-start">Quick Start</a>
8
- <a href="#for-ai-agents">For AI Agents</a>
9
- <a href="#command-reference">Commands</a>
10
- <a href="#concepts">Concepts</a>
7
+ <a href="https://www.npmjs.com/package/clishop"><img alt="npm" src="https://img.shields.io/npm/v/clishop?style=flat-square&color=cb3837" /></a>
8
+ <a href="https://clishop.ai"><img alt="Website" src="https://img.shields.io/badge/website-clishop.ai-blue?style=flat-square" /></a>
9
+ <a href="https://discord.gg/vwXMbzD4bx"><img alt="Discord" src="https://img.shields.io/badge/Discord-Join-5865F2?style=flat-square&logo=discord&logoColor=white" /></a>
11
10
  </p>
12
11
  </p>
13
12
 
14
13
  ---
15
14
 
15
+ CLISHOP is an open-source CLI that lets AI agents and humans search for products across multiple stores, compare prices, and place real orders — all from the terminal. Anyone can sell on CLISHOP using a [Dark Store](https://github.com/DavooxBv2/CLISHOP-DARKSTORE).
16
+
16
17
  ## Works with
17
18
 
18
19
  <p>
@@ -22,175 +23,34 @@
22
23
  <img alt="Gemini" src="https://img.shields.io/badge/Gemini-Supported-4285F4?style=for-the-badge&logo=googlegemini&logoColor=white" />
23
24
  </p>
24
25
  <p>
25
- <img alt="AutoGPT" src="https://img.shields.io/badge/AutoGPT-Open--source%20agent-111827?style=for-the-badge&logo=github&logoColor=white" />
26
- <img alt="CrewAI" src="https://img.shields.io/badge/CrewAI-Open--source%20agent-0EA5E9?style=for-the-badge&logo=crewai&logoColor=white" />
27
- <img alt="LangGraph" src="https://img.shields.io/badge/LangGraph-Open--source%20agent-16A34A?style=for-the-badge&logo=langchain&logoColor=white" />
26
+ <img alt="Cursor" src="https://img.shields.io/badge/Cursor-Supported-000000?style=for-the-badge&logo=cursor&logoColor=white" />
27
+ <img alt="Windsurf" src="https://img.shields.io/badge/Windsurf-Supported-0EA5E9?style=for-the-badge" />
28
+ <img alt="AutoGPT" src="https://img.shields.io/badge/AutoGPT-Agent-111827?style=for-the-badge&logo=github&logoColor=white" />
29
+ <img alt="LangGraph" src="https://img.shields.io/badge/LangGraph-Agent-16A34A?style=for-the-badge&logo=langchain&logoColor=white" />
28
30
  </p>
29
31
 
30
- CLISHOP lets AI agents and scripts autonomously search for products across multiple stores, compare prices, and place orders — entirely through a command-line interface. No browser. No GUI. Just `stdin`/`stdout`.
32
+ ## Highlights
31
33
 
32
- Built for the [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) era, where AI agents need tool-use interfaces to interact with the real world.
34
+ - **Multi-store search:** one query searches every store in the network and only returns items that ship to your address
35
+ - **Safety thresholds:** cap how much can be spent per order, require email confirmation before anything ships, or skip confirmation entirely
36
+ - **MCP server:** native [Model Context Protocol](https://modelcontextprotocol.io/) support with 19 tools so AI agents (VS Code Copilot, Claude, Cursor, Windsurf, etc.) can shop on your behalf
37
+ - **Advertise requests:** can't find what you need? Publicly post a request and let stores try to find it for you
38
+ - **Support & reviews:** if something goes wrong, create support tickets and handle the entire process from the CLI — write product and store reviews too
39
+ - **Open marketplace:** anyone can start selling on CLISHOP by deploying a [Dark Store](https://github.com/DavooxBv2/CLISHOP-DARKSTORE) — no website required
33
40
 
34
- ## MCP Server
41
+ ---
35
42
 
36
- CLISHOP ships as a native MCP server. VS Code (GitHub Copilot), Claude Desktop, Cursor, Windsurf, and any MCP-compatible client gets access to 19 shopping tools out of the box.
43
+ ## Install
37
44
 
38
- Install globally and run the dedicated binary:
45
+ Requires **Node.js 18**.
39
46
 
40
47
  ```bash
41
48
  npm install -g clishop
42
- clishop-mcp
43
- ```
44
-
45
- Or run without installing:
46
-
47
- ```bash
48
- npx -y clishop --mcp
49
- ```
50
-
51
- ### VS Code (GitHub Copilot)
52
-
53
- Add to `.vscode/mcp.json` in your workspace:
54
-
55
- ```json
56
- {
57
- "servers": {
58
- "clishop": {
59
- "command": "clishop-mcp",
60
- "args": []
61
- }
62
- }
63
- }
64
- ```
65
-
66
- Or add to your VS Code `settings.json`:
67
-
68
- ```json
69
- {
70
- "mcp": {
71
- "servers": {
72
- "clishop": {
73
- "command": "clishop-mcp",
74
- "args": []
75
- }
76
- }
77
- }
78
- }
79
- ```
80
-
81
- If you don't have clishop installed globally, use npx instead:
82
-
83
- ```json
84
- {
85
- "servers": {
86
- "clishop": {
87
- "command": "npx",
88
- "args": ["-y", "clishop", "--mcp"]
89
- }
90
- }
91
- }
92
- ```
93
-
94
- ### Claude Desktop
95
-
96
- Add to `claude_desktop_config.json`:
97
-
98
- ```json
99
- {
100
- "mcpServers": {
101
- "clishop": {
102
- "command": "clishop-mcp"
103
- }
104
- }
105
- }
106
49
  ```
107
50
 
108
- Or if not installed globally:
109
-
110
- ```json
111
- {
112
- "mcpServers": {
113
- "clishop": {
114
- "command": "npx",
115
- "args": ["-y", "clishop", "--mcp"]
116
- }
117
- }
118
- }
119
- ```
120
-
121
- ### Cursor
122
-
123
- Add to `.cursor/mcp.json`:
124
-
125
- ```json
126
- {
127
- "mcpServers": {
128
- "clishop": {
129
- "command": "clishop-mcp"
130
- }
131
- }
132
- }
133
- ```
134
-
135
- ### Windsurf
136
-
137
- Add to `~/.windsurf/mcp.json`:
138
-
139
- ```json
140
- {
141
- "mcpServers": {
142
- "clishop": {
143
- "command": "clishop-mcp"
144
- }
145
- }
146
- }
147
- ```
148
-
149
- ### Available MCP Tools
150
-
151
- | Tool | Description |
152
- |------|-------------|
153
- | `search_products` | Search products across all stores with filters |
154
- | `get_product` | Get detailed product info |
155
- | `buy_product` | Place an order with safety checks |
156
- | `list_orders` | List orders by status |
157
- | `get_order` | Get order details + tracking |
158
- | `cancel_order` | Cancel a pending order |
159
- | `list_addresses` | List shipping addresses |
160
- | `add_address` | Add a shipping address |
161
- | `remove_address` | Remove a shipping address |
162
- | `list_payment_methods` | List payment methods |
163
- | `list_stores` | Browse available stores |
164
- | `get_store` | Get store details |
165
- | `store_catalog` | Browse a store's catalog |
166
- | `account_status` | Full account overview |
167
- | `list_agents` | List safety agents |
168
- | `create_advertise_request` | Post a request for vendors to bid on |
169
- | `create_support_ticket` | Open a support ticket |
170
- | `list_support_tickets` | List support tickets |
171
- | `submit_feedback` | Report bugs or suggest improvements |
172
-
173
- > **Prerequisite:** Log in once with `clishop login` before using MCP tools. The MCP server uses the same auth tokens stored in your OS keychain.
174
-
175
- ## Highlights
176
-
177
- - **Multi-store search** — Query products across many vendors in one command
178
- - **Extended search** — Real-time queries to vendor stores when local catalog doesn't have what you need
179
- - **Agent profiles** — Safety guardrails: spending caps, category restrictions, confirmation prompts
180
- - **Non-interactive mode** — Every command works without prompts (flags + `--json` output)
181
- - **Advertise requests** — Can't find it? Publish what you need and let vendors bid
182
- - **Secure payments** — Card details never touch the CLI; payment setup uses secure browser links
183
- - **OS keychain auth** — Tokens stored in the system keychain, not config files
184
-
185
- ## Quick Start
186
-
187
- ### Install from npm
188
-
189
- ```bash
190
- npm install -g clishop
191
- ```
51
+ This gives you two commands: `clishop` (the CLI) and `clishop-mcp` (the MCP server for AI agents).
192
52
 
193
- ### Or build from source
53
+ To install from source instead:
194
54
 
195
55
  ```bash
196
56
  git clone https://github.com/DavooxBv2/CLISHOP.git
@@ -200,375 +60,52 @@ npm run build
200
60
  npm link
201
61
  ```
202
62
 
203
- ### First run
204
-
205
- ```bash
206
- clishop
207
- ```
208
-
209
- Running `clishop` with no arguments triggers a guided setup wizard:
210
-
211
- 1. Create an account or log in
212
- 2. Configure an agent (a `default` agent is created automatically)
213
- 3. Add a shipping address
214
- 4. Link a payment method (opens a secure browser link)
215
- 5. Run your first search
216
-
217
- Re-run setup anytime with `clishop setup`.
218
-
219
- **Requirements:** Node.js ≥ 18
220
-
221
- ## For AI Agents
222
-
223
- CLISHOP is designed to be called by AI agents, scripts, and automation pipelines. Every command supports non-interactive flags and machine-readable JSON output.
224
-
225
- ### Authenticate
226
-
227
- ```bash
228
- echo "<password>" | clishop login --email <email> --password-stdin
229
- ```
230
-
231
- ### Search → Buy flow
232
-
233
- ```bash
234
- # Search for products (JSON output for parsing)
235
- clishop search "wireless headphones" --json
236
-
237
- # View product details
238
- clishop product prod_a8k3m2x9p4w1 --json
239
-
240
- # Buy it (skip confirmation prompt)
241
- clishop buy prod_a8k3m2x9p4w1 -y
242
-
243
- # Check order status
244
- clishop order list --json
245
- ```
246
-
247
- ### Use agent safety profiles
248
-
249
- Agents act as guardrails. Create a `shopping-bot` agent with a $50 spending cap:
250
-
251
- ```bash
252
- clishop agent create shopping-bot --max-amount 50 --no-confirm
253
- ```
254
-
255
- Then use it:
256
-
257
- ```bash
258
- clishop search "USB-C cable" --agent shopping-bot --json
259
- clishop buy prod_xxx --agent shopping-bot -y
260
- ```
261
-
262
- ### JSON output everywhere
263
-
264
- Append `--json` to any read command for structured output:
265
-
266
- ```bash
267
- clishop search "laptop stand" --json
268
- clishop order list --json
269
- clishop order show ordr_xxx --json
270
- clishop product prod_xxx --json
271
- clishop review list --json
272
- clishop store list --json
273
- clishop status --json
274
- clishop advertise list --json
275
- clishop support list --json
276
- clishop feedback list --json
277
- ```
278
-
279
- ### Exit codes
280
-
281
- | Code | Meaning |
282
- |------|---------|
283
- | `0` | Success |
284
- | `1` | Error (auth failure, not found, validation, API error) |
285
-
286
- Errors are printed to `stderr`. Successful JSON output goes to `stdout`.
287
-
288
- ## Concepts
289
-
290
- ### Agents
291
-
292
- Agents are **safety profiles** that control how the CLI behaves when placing orders. Every account has a `default` agent.
293
-
294
- | Setting | Description |
295
- |---------|-------------|
296
- | `maxOrderAmount` | Spending cap per order (in dollars) |
297
- | `requireConfirmation` | Prompt before placing an order |
298
- | `allowedCategories` | Whitelist of product categories |
299
- | `blockedCategories` | Blacklist of product categories |
300
- | `defaultAddressId` | Default shipping address |
301
- | `defaultPaymentMethodId` | Default payment method |
302
-
303
- Use `--agent <name>` on any command to override the active agent for that invocation.
304
-
305
- ### Stores & Extended Search
306
-
307
- Products live in stores (vendors). When a regular search doesn't find what you need, CLISHOP can automatically query vendor stores in real-time via **extended search**. This happens automatically when no local results are found, or can be forced with `--extended-search`.
308
-
309
- After an extended search, use `clishop info <id>` to request detailed product information directly from the vendor's store.
310
-
311
- ### Advertised Requests
312
-
313
- Can't find what you're looking for? Publish a request describing what you need, and vendors can submit bids:
314
-
315
- ```bash
316
- # Interactive
317
- clishop advertise create
318
-
319
- # Non-interactive (for agents)
320
- clishop advertise quick "Custom engraved laptop stand" \
321
- --brand "StandCo" \
322
- --bid-price 89.99 \
323
- --quantity 1 \
324
- --speed 5 \
325
- --free-returns
326
- ```
327
-
328
- Vendors see your request and can submit bids with pricing, delivery estimates, and return policies. You (or your agent) can then accept or reject bids.
329
-
330
- ### IDs
331
-
332
- All entities use short, prefixed IDs:
333
-
334
- | Prefix | Entity | Example |
335
- |--------|--------|---------|
336
- | `prod_` | Product | `prod_a8k3m2x9p4w1` |
337
- | `ordr_` | Order | `ordr_b7n4q1y8t3v6` |
338
- | `addr_` | Address | `addr_c9j2w5r8m1k4` |
339
- | `pymt_` | Payment method | `pymt_d3f8k1n7p2q9` |
340
- | `stor_` | Store | `stor_e4g7j2m8r5t1` |
341
- | `user_` | User | `user_f5h8k3n9s6v2` |
342
- | `agnt_` | Agent | `agnt_g6j9l4p1t7w3` |
343
- | `chkt_` | Checkout | `chkt_h7k1m5q2u8x4` |
344
- | `fdbk_` | Feedback | `fdbk_i8l2n6r3v9y5` |
345
-
346
- ### Money
347
-
348
- All prices are stored and returned in **cents** (integer). The CLI converts to dollars for display. Example: `7999` → `$79.99`.
349
-
350
- ## Command Reference
351
-
352
- ### Authentication
353
-
354
- ```bash
355
- clishop register # Interactive account creation
356
- clishop login # Interactive login
357
- clishop login -e user@example.com -p pass # Non-interactive login
358
- clishop logout # Clear local tokens
359
- clishop whoami # Print current user info
360
- ```
361
-
362
- ### Search & Browse
363
-
364
- ```bash
365
- clishop search <query> # Search for products
366
- clishop search <query> --json # JSON output
367
- clishop search <query> -c Electronics # Filter by category
368
- clishop search <query> --brand Sony # Filter by brand
369
- clishop search <query> --store AudioTech # Filter by store
370
- clishop search <query> --min-price 1000 # Min price (cents)
371
- clishop search <query> --max-price 10000 # Max price (cents)
372
- clishop search <query> --min-rating 4 # Min rating (1-5)
373
- clishop search <query> --in-stock # Only in-stock items
374
- clishop search <query> --free-shipping # Free shipping only
375
- clishop search <query> --free-returns # Free returns only
376
- clishop search <query> --express # 2-day or faster delivery
377
- clishop search <query> --ship-to "Home" # Use saved address for location
378
- clishop search <query> --country US # Delivery country
379
- clishop search <query> --deliver-by 2026-03-01 # Need it by date
380
- clishop search <query> --trusted-only # Verified stores only
381
- clishop search <query> -e # Force extended search
382
- clishop search <query> -i # Interactive: select products for more info
383
- clishop search <query> --compact # One-line-per-result output
384
- clishop search <query> --detailed # Full details inline
385
- clishop search <query> -s price --order asc # Sort by price ascending
386
- clishop search <query> -p 2 -n 10 # Page 2, 10 results per page
387
-
388
- clishop product <productId> # View product details
389
- clishop product <productId> --json # JSON output
390
-
391
- clishop info <id> [id...] # Get detailed info from vendor stores
392
- clishop info <id> --json # JSON output
393
- ```
394
-
395
- **Sort options:** `price`, `total-cost`, `rating`, `relevance`, `newest`, `delivery`
396
-
397
- ### Ordering
398
-
399
- ```bash
400
- clishop buy <productId> # Quick-buy with defaults
401
- clishop buy <productId> -q 3 # Buy quantity 3
402
- clishop buy <productId> --address <id> # Specify shipping address
403
- clishop buy <productId> --payment <id> # Specify payment method
404
- clishop buy <productId> -y # Skip confirmation prompt
405
- clishop buy <productId> --agent work # Use a specific agent
406
-
407
- clishop order list # List your orders
408
- clishop order list --status pending # Filter by status
409
- clishop order list --json # JSON output
410
- clishop order show <orderId> # Order details + tracking
411
- clishop order cancel <orderId> # Cancel an order
412
- ```
413
-
414
- **Order statuses:** `pending`, `confirmed`, `processing`, `shipped`, `delivered`, `cancelled`
415
-
416
- ### Agents
417
-
418
- ```bash
419
- clishop agent list # List all agents
420
- clishop agent show # Show active agent
421
- clishop agent show <name> # Show specific agent
422
- clishop agent create <name> # Interactive creation
423
- clishop agent create <name> --max-amount 100 --no-confirm # Non-interactive
424
- clishop agent use <name> # Switch active agent
425
- clishop agent update <name> # Update agent settings
426
- clishop agent delete <name> # Delete (can't delete "default")
427
- ```
428
-
429
- ### Addresses
430
-
431
- ```bash
432
- clishop address list # List addresses
433
- clishop address add # Interactive: add address
434
- clishop address remove <id> # Remove address
435
- clishop address set-default <id> # Set default for active agent
436
- ```
437
-
438
- ### Payment Methods
439
-
440
- ```bash
441
- clishop payment list # List payment methods
442
- clishop payment add # Get secure setup link
443
- clishop payment remove <id> # Remove payment method
444
- clishop payment set-default <id> # Set default for active agent
445
- ```
63
+ ## Quick Start
446
64
 
447
- ### Reviews
65
+ You can create your account on [clishop.ai](https://clishop.ai) or do everything from the CLI:
448
66
 
449
67
  ```bash
450
- clishop review add <productId> # Write a review
451
- clishop review list # List your reviews
452
- clishop review list --json # JSON output
453
- clishop review delete <reviewId> # Delete a review
68
+ clishop setup
454
69
  ```
455
70
 
456
- ### Stores
71
+ The setup wizard walks you through creating an account, adding an address, and linking a payment method. After that:
457
72
 
458
- ```bash
459
- clishop store list # List available stores
460
- clishop store list --verified # Only verified stores
461
- clishop store list --min-rating 4 # Min store rating
462
- clishop store info <store> # Store details
463
- clishop store catalog <store> # Browse store products
464
- clishop store catalog <store> -q "cable" # Search within store
465
73
  ```
74
+ $ clishop search "wireless headphones"
466
75
 
467
- ### Advertised Requests
76
+ 🔍 Search results for "wireless headphones"
468
77
 
469
- ```bash
470
- clishop advertise create # Interactive: publish a request
471
- clishop advertise quick <title> # Non-interactive: publish a request
472
- clishop advertise list # List your requests
473
- clishop advertise show <id> # View request + bids
474
- clishop advertise accept <id> <bidId> # Accept a vendor bid
475
- clishop advertise reject <id> <bidId> # Reject a vendor bid
476
- clishop advertise cancel <id> # Cancel a request
477
- ```
78
+ 1 Sony WH-1000XM5 $278.00
79
+ SUPERSTORE · 8.1 · Free shipping · 3-5 days
478
80
 
479
- ### Support Tickets
81
+ 2 JBL Tune 770NC Wireless $79.95
82
+ EveryMarket · ★ 7.9 · $5.99 shipping · 5-8 days
480
83
 
481
- ```bash
482
- clishop support create <orderId> # Create a support ticket
483
- clishop support list # List your tickets
484
- clishop support show <ticketId> # View ticket + messages
485
- clishop support reply <ticketId> # Reply to a ticket
486
- clishop support close <ticketId> # Close a ticket
487
84
  ```
488
85
 
489
- ### Bug Reports & Suggestions
490
-
491
- Found a bug? Have an idea to make CLISHOP better? Report it directly from the terminal:
492
-
493
- ```bash
494
- # Report a bug (interactive — prompts for details)
495
- clishop feedback bug
496
-
497
- # Report a bug (non-interactive — for agents/scripts)
498
- clishop feedback bug \
499
- --title "Search crashes on empty query" \
500
- --description "Running search with no query causes unhandled error" \
501
- --steps "1. Run: clishop search \"\"\n2. Observe crash" \
502
- --actual "CLI exits with stack trace" \
503
- --expected "Should show a friendly 'query required' error"
504
-
505
- # Submit a suggestion (interactive)
506
- clishop feedback suggest
507
-
508
- # Submit a suggestion (non-interactive)
509
- clishop feedback suggest \
510
- --title "Add wishlist feature" \
511
- --description "Would be great to save products to a wishlist for later"
512
-
513
- # List your feedback
514
- clishop feedback list # All feedback
515
- clishop feedback list --type bug # Only bug reports
516
- clishop feedback list --type suggestion # Only suggestions
517
- clishop feedback list --status fixed # Filter by status
518
- clishop feedback list --json # JSON output
519
-
520
- # View a specific report
521
- clishop feedback show <id> # View details + status
522
- clishop feedback show <id> --json # JSON output
523
86
  ```
87
+ $ clishop info 1
524
88
 
525
- **Bug report fields:**
526
- | Field | Description |
527
- |-------|-------------|
528
- | `title` | Short summary of the bug |
529
- | `description` | General description |
530
- | `steps` | How to trigger the bug (steps to reproduce) |
531
- | `actual` | What actually happens |
532
- | `expected` | What you expected to happen |
533
-
534
- **Feedback statuses:** `open`, `acknowledged`, `in_progress`, `fixed`, `wont_fix`, `closed`
535
-
536
- The CLISHOP team reviews all feedback and updates the status. You'll see admin notes when you check your feedback with `clishop feedback show <id>`.
537
-
538
- ### Account & Config
539
-
540
- ```bash
541
- clishop status # Full account overview
542
- clishop status --json # JSON output
543
-
544
- clishop config show # Show current config
545
- clishop config set-output json # Set output format (human | json)
546
- clishop config reset # Reset config to defaults
547
- clishop config path # Print config file path
89
+ Sony WH-1000XM5
90
+ ─────────────────────────────────────
91
+ Price: $278.00
92
+ Store: SUPERSTORE (★ 8.1)
93
+ Shipping: Free · 3-5 business days
94
+ Returns: 30-day free returns
95
+ In stock: Yes
548
96
 
549
- clishop setup # Re-run setup wizard
97
+ Industry-leading noise cancellation with
98
+ Auto NC Optimizer. 30-hour battery life.
99
+ Multipoint connection for two devices.
550
100
  ```
551
101
 
552
- ## Configuration
553
-
554
- | Data | Location |
555
- |------|----------|
556
- | CLI config (agents, preferences) | `~/.config/clishop/config.json` (or OS equivalent) |
557
- | Auth tokens | OS keychain (via `keytar`) |
558
-
559
- Find the config path:
560
-
561
102
  ```bash
562
- clishop config path
103
+ clishop buy 1
563
104
  ```
564
105
 
565
- ## Environment Variables
106
+ > **Tip:** use result numbers from a search anywhere — `clishop info 1 2 3` or `clishop buy 2`.
566
107
 
567
- | Variable | Purpose | Default |
568
- |----------|---------|---------|
569
- | `CLISHOP_API_URL` | Override the backend API URL | `https://clishop-backend.vercel.app/api` |
570
-
571
- `CLISHOP_API_URL` takes precedence over the local `config.apiBaseUrl` value.
108
+ ---
572
109
 
573
110
  ## Architecture
574
111
 
@@ -583,58 +120,62 @@ clishop config path
583
120
  └───────┬───────┘
584
121
  │ HTTPS
585
122
  ┌───────▼───────┐
586
- │ CLISHOP API │ ← clishop-backend
587
- │ (Vercel) │
123
+ │ CLISHOP API │ ← backend (Vercel)
588
124
  └───────┬───────┘
589
125
 
590
126
  ┌──────────┼──────────┐
591
127
  ▼ ▼ ▼
592
- Store A Store B Store C ← vendor stores
128
+ Store A Store B Store C ← vendor Dark Stores
593
129
  ```
594
130
 
595
- The CLI is a stateless client. It doesn't own any database or vendor integrations — all data flows through the backend API.
131
+ ---
596
132
 
597
- ## Tech Stack
133
+ ## Sell on CLISHOP
598
134
 
599
- | Component | Technology |
600
- |-----------|------------|
601
- | Language | TypeScript (ESM) |
602
- | CLI framework | [Commander.js](https://github.com/tj/commander.js) |
603
- | HTTP client | [Axios](https://github.com/axios/axios) |
604
- | Prompts | [Inquirer.js](https://github.com/SBoudrias/Inquirer.js) |
605
- | Config storage | [Conf](https://github.com/sindresorhus/conf) |
606
- | Keychain | [Keytar](https://github.com/nicktrav/node-keytar) |
607
- | Spinners | [Ora](https://github.com/sindresorhus/ora) |
608
- | Colors | [Chalk](https://github.com/chalk/chalk) |
609
- | Bundler | [tsup](https://github.com/egoist/tsup) |
135
+ Want to sell your own products? Use the [Dark Store](https://github.com/DavooxBv2/CLISHOP-DARKSTORE) template to create your own store — no website needed. Configure your catalog, shipping, and pricing in a few YAML files, deploy to Vercel, and start receiving orders.
136
+
137
+ ---
610
138
 
611
139
  ## Development
612
140
 
613
141
  ```bash
614
142
  git clone https://github.com/DavooxBv2/CLISHOP.git
615
- cd CLISHOP
616
- npm install
143
+ cd CLISHOP && npm install
144
+ npm run dev -- search "headphones" # Dev mode (no build needed)
145
+ npm run build # Production build
146
+ npm run lint # Type-check
147
+ ```
617
148
 
618
- # Run in dev mode (no build step)
619
- npm run dev -- search "headphones"
149
+ ---
620
150
 
621
- # Build
622
- npm run build
151
+ ## MCP Server
152
+
153
+ CLISHOP ships as a native MCP server with 19 tools. Any MCP-compatible client gets shopping capabilities out of the box.
623
154
 
624
- # Type-check
625
- npm run lint
155
+ ```bash
156
+ clishop-mcp # If installed globally
157
+ npx -y clishop --mcp # Without installing
626
158
  ```
627
159
 
628
- ## Contributing
160
+ See the [MCP setup guides](https://clishop.ai/docs#mcp-overview) for VS Code, Claude Desktop, Cursor, and Windsurf configuration.
161
+
162
+ ---
163
+
164
+ ## Docs
165
+
166
+ Full command reference, agent configuration, search filters, and more:
167
+
168
+ **[→ clishop.ai/docs](https://clishop.ai/docs)**
169
+
170
+ ---
629
171
 
630
- Contributions are welcome! Please open an issue first to discuss what you'd like to change.
172
+ ## Links
631
173
 
632
- 1. Fork the repo
633
- 2. Create a feature branch (`git checkout -b feat/my-feature`)
634
- 3. Commit your changes (`git commit -m 'feat: add my feature'`)
635
- 4. Push to the branch (`git push origin feat/my-feature`)
636
- 5. Open a Pull Request
174
+ - 🌐 [clishop.ai](https://clishop.ai)
175
+ - 📖 [Docs](https://clishop.ai/docs)
176
+ - 💬 [Discord](https://discord.gg/vwXMbzD4bx)
177
+ - 🏪 [Dark Store](https://github.com/DavooxBv2/CLISHOP-DARKSTORE)
637
178
 
638
179
  ## License
639
180
 
640
- [ISC](LICENSE)
181
+ [MIT](LICENSE)
package/package.json CHANGED
@@ -1,15 +1,18 @@
1
1
  {
2
2
  "name": "clishop",
3
- "version": "1.0.1",
3
+ "version": "1.1.1",
4
4
  "mcpName": "io.github.StefDCL/clishop",
5
5
  "description": "CLISHOP — Order anything from your terminal",
6
6
  "main": "dist/index.js",
7
+ "files": [
8
+ "dist"
9
+ ],
7
10
  "bin": {
8
11
  "clishop": "dist/index.js",
9
12
  "clishop-mcp": "dist/mcp.js"
10
13
  },
11
14
  "scripts": {
12
- "build": "tsup src/index.ts src/mcp.ts --format esm --dts --clean --target node18",
15
+ "build": "tsup",
13
16
  "dev": "tsx src/index.ts",
14
17
  "dev:mcp": "tsx src/mcp.ts",
15
18
  "start": "node dist/index.js",
@@ -30,7 +33,7 @@
30
33
  "agent"
31
34
  ],
32
35
  "author": "",
33
- "license": "ISC",
36
+ "license": "MIT",
34
37
  "type": "module",
35
38
  "engines": {
36
39
  "node": ">=18"
package/SECURITY.md DELETED
@@ -1,25 +0,0 @@
1
- # Security Policy
2
-
3
- ## Reporting a Vulnerability
4
-
5
- If you discover a security issue in CLISHOP CLI, please report it privately:
6
-
7
- - Open a private security advisory on GitHub (preferred), or
8
- - Contact the maintainers via repository security contact.
9
-
10
- Please include:
11
- - A clear description of the issue
12
- - Reproduction steps / proof of concept
13
- - Potential impact
14
- - Suggested remediation (if available)
15
-
16
- ## Supported Versions
17
-
18
- Until a stable `1.0.0` release is published, only the latest release line is considered supported for security fixes.
19
-
20
- ## Security Expectations
21
-
22
- - Never commit secrets or tokens.
23
- - Use OS keychain-backed credentials where available.
24
- - Prefer secure non-interactive auth methods over plaintext CLI arguments.
25
- - Keep dependencies up to date and monitor advisories.
package/server.json DELETED
@@ -1,23 +0,0 @@
1
- {
2
- "$schema": "https://static.modelcontextprotocol.io/schemas/2025-12-11/server.schema.json",
3
- "name": "io.github.StefDCL/clishop",
4
- "description": "Order anything from your terminal — search, buy, track, and manage via MCP tools.",
5
- "repository": {
6
- "url": "https://github.com/DavooxBv2/CLISHOP",
7
- "source": "github"
8
- },
9
- "version": "0.3.0",
10
- "packages": [
11
- {
12
- "registryType": "npm",
13
- "identifier": "clishop",
14
- "version": "0.3.0",
15
- "runtime": "node",
16
- "args": ["--mcp"],
17
- "transport": {
18
- "type": "stdio"
19
- },
20
- "environmentVariables": []
21
- }
22
- ]
23
- }