@opencommerceprotocol/cli 1.0.0

package/LICENSE

@@ -0,0 +1,144 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship made available under
+      the License, as indicated by a copyright notice that is included in
+      or attached to the work (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other transformations
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean, as submitted to the Licensor for inclusion
+      in the Work by the copyright owner or by an individual or Legal Entity
+      authorized to submit on behalf of the copyright owner. For the purposes
+      of this definition, "submitted" means any form of electronic, verbal, or
+      written communication sent to the Licensor or its representatives,
+      including but not limited to communication on electronic mailing lists,
+      source code control systems, and issue tracking systems that are managed
+      by, or on behalf of, the Licensor for the purpose of discussing and
+      improving the Work, but excluding communication that is conspicuously
+      marked or designated in writing by the copyright owner as "Not a
+      Contribution."
+
+      "Contributor" shall mean Licensor and any Legal Entity on behalf of
+      whom a Contribution has been received by the Licensor and included
+      within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by the combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a cross-claim
+      or counterclaim in a lawsuit) alleging that the Work or any
+      Contribution embodied within the Work constitutes direct or contributory
+      patent infringement, then any patent licenses granted to You under this
+      License for that Work shall terminate as of the date such litigation
+      is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative Works
+          a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file, You must include a
+          readable copy of the attribution notices contained within such
+          NOTICE file.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND.
+
+   8. Limitation of Liability. In no event and under no legal theory shall
+      any Contributor be liable to You for damages, including any direct,
+      indirect, special, incidental, or exemplary damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing the
+      Work or Derivative Works thereof, You may offer, and charge a fee for,
+      acceptance of support, warranty, indemnity, or other liability
+      obligations consistent with this License. However, in accepting such
+      obligations, You may act only on Your own behalf and on Your sole
+      responsibility.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Open Commerce Protocol Contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,263 @@
+# @opencommerceprotocol/cli
+
+Command-line tool for the [Open Commerce Protocol](https://opencommerceprotocol.org). Set up, validate, and manage OCP for any website.
+
+## Installation
+
+```bash
+npm install -g @opencommerceprotocol/cli
+# or use without installing:
+npx @opencommerceprotocol/cli <command>
+```
+
+## Commands
+
+### `ocp init`
+
+Interactive wizard to generate OCP files for your store.
+
+```bash
+ocp init
+ocp init --output ./public
+```
+
+Generates:
+- `.well-known/ocp.json` — manifest
+- `ocp/products.jsonl` — product feed
+- `ocp.md` — natural language store description
+
+---
+
+### `ocp crawl <url>`
+
+Crawl a website and extract Schema.org Product JSON-LD to generate OCP files automatically.
+
+```bash
+ocp crawl https://mystore.com
+ocp crawl https://mystore.com --output ./ocp-output
+ocp crawl https://mystore.com --max-products 500
+ocp crawl https://mystore.com --product-pattern "/products/"
+ocp crawl https://mystore.com --dry-run   # list URLs without fetching
+ocp crawl https://mystore.com --verbose   # detailed per-URL output
+```
+
+| Flag | Default | Description |
+|------|---------|-------------|
+| `--output <dir>` | `./ocp-output` | Output directory |
+| `--concurrency <n>` | `5` | Max concurrent requests |
+| `--delay <ms>` | `200` | Delay between requests |
+| `--product-pattern <regex>` | — | URL pattern for product pages |
+| `--max-products <n>` | — | Maximum products to extract |
+| `--user-agent <string>` | `OCPBot/1.0` | Custom User-Agent |
+| `--include-variants` | `true` | Extract product variants |
+| `--generate-agent-notes` | `true` | Auto-generate `agent_notes` |
+| `--dry-run` | `false` | List URLs without fetching |
+| `--resume` | `false` | Resume interrupted crawl |
+
+---
+
+### `ocp validate <target>`
+
+Validate a live site or local directory. Shows a 0–100 quality score.
+
+```bash
+ocp validate https://mystore.com
+ocp validate ./public   # local directory
+```
+
+Checks:
+- Manifest structure and required fields
+- Product feed validity
+- `robots.txt` has `OCP-Manifest` directive
+- `llms.txt` has Commerce section
+- `agent_notes` quality scores
+
+---
+
+### `ocp generate`
+
+Generate OCP files from a product CSV, JSON, or JSONL file.
+
+```bash
+ocp generate --products catalog.csv
+ocp generate --products catalog.json
+ocp generate --products catalog.jsonl
+ocp generate --products catalog.csv --config ocp.config.json --output ./public
+```
+
+CSV example:
+```csv
+id,name,price,currency,url,description
+prod-001,Headphones,149.99,USD,https://mystore.com/headphones,Premium wireless headphones
+```
+
+| Flag | Default | Description |
+|------|---------|-------------|
+| `--products <file>` | — | Input file (.csv, .json, or .jsonl) |
+| `--config <file>` | — | OCP config file |
+| `--output <dir>` | `.` | Output directory |
+
+---
+
+### `ocp bridge`
+
+Generate bridge configuration for other agent protocols.
+
+```bash
+ocp bridge --protocol mcp
+ocp bridge --protocol ucp
+ocp bridge --protocol a2a
+ocp bridge --manifest .well-known/ocp.json --output ./bridge
+```
+
+| Flag | Default | Description |
+|------|---------|-------------|
+| `--protocol <protocol>` | `mcp` | Target: `mcp`, `ucp`, or `a2a` |
+| `--manifest <file>` | `.well-known/ocp.json` | OCP manifest file |
+| `--output <dir>` | `./bridge` | Output directory |
+
+---
+
+### `ocp robots [path]`
+
+Add the `OCP-Manifest` directive to your `robots.txt`.
+
+```bash
+ocp robots              # updates ./robots.txt in place
+ocp robots /etc/nginx/robots.txt
+ocp robots --stdout     # print to stdout
+ocp robots --url https://mystore.com/.well-known/ocp.json
+```
+
+Result in `robots.txt`:
+```
+OCP-Manifest: https://mystore.com/.well-known/ocp.json
+```
+
+---
+
+### `ocp llms [path]`
+
+Generate or patch `llms.txt` with an OCP Commerce section.
+
+```bash
+ocp llms              # updates ./llms.txt in place
+ocp llms --stdout     # print to stdout
+ocp llms --full       # also generate llms-full.txt with product descriptions
+```
+
+---
+
+### `ocp stats [url]`
+
+Analyze server access logs to understand AI agent traffic.
+
+```bash
+ocp stats --log /var/log/nginx/access.log
+ocp stats https://mystore.com --log access.log --format nginx --days 30
+ocp stats --log access.log --format apache
+ocp stats --log access.log --format cloudflare
+```
+
+Reports:
+- Total agent visits by bot (ChatGPT, Claude, Gemini, etc.)
+- Products most viewed by agents
+- Search queries agents used
+- Agent traffic trends over time
+
+| Flag | Default | Description |
+|------|---------|-------------|
+| `--log <file>` | — | Path to log file |
+| `--format <format>` | `nginx` | Log format: `nginx`, `apache`, `cloudflare` |
+| `--days <n>` | `30` | Number of days to analyze |
+
+---
+
+### `ocp test-agent <url>`
+
+Simulate an AI agent visiting your store and produce a pass/fail conformance report.
+
+```bash
+ocp test-agent https://mystore.com
+ocp test-agent https://mystore.com --query "blue running shoes"
+ocp test-agent https://mystore.com --verbose
+```
+
+| Flag | Default | Description |
+|------|---------|-------------|
+| `--query <query>` | `product` | Test search query |
+| `--verbose` | `false` | Show detailed output and sample `agent_notes` |
+
+---
+
+### `ocp preview <url>`
+
+Render what an AI agent sees when visiting your store.
+
+```bash
+ocp preview https://mystore.com
+ocp preview https://mystore.com --products 10
+ocp preview https://mystore.com --verbose
+```
+
+| Flag | Default | Description |
+|------|---------|-------------|
+| `--products <n>` | `5` | Number of sample products to show |
+| `--verbose` | `false` | Show full `ocp.md` and best/worst `agent_notes` |
+
+---
+
+### `ocp agent-discover <url>`
+
+Discover agent tools at any URL via `/.well-known/agent.json` or OCP fallback.
+
+```bash
+ocp agent-discover https://mystore.com
+ocp agent-discover https://mystore.com --verbose
+ocp agent-discover https://mystore.com --format json
+ocp agent-discover https://mystore.com --format mcp
+ocp agent-discover https://mystore.com --format openai
+```
+
+| Flag | Default | Description |
+|------|---------|-------------|
+| `--verbose` | `false` | Show full tool list with descriptions |
+| `--format <format>` | `text` | Output: `text`, `json`, `mcp`, `openai` |
+
+---
+
+## CI/CD Integration
+
+### Validate on deploy (GitHub Actions)
+
+```yaml
+- name: Validate OCP
+  run: npx @opencommerceprotocol/cli validate https://mystore.com
+```
+
+### Cron sync with `generate`
+
+```bash
+# crontab: regenerate feed daily at midnight
+0 0 * * * ocp generate --products /data/products.csv --output /var/www/html
+```
+
+## Configuration File
+
+Create `ocp.config.json` for `generate`:
+
+```json
+{
+  "merchant": {
+    "name": "My Store",
+    "url": "https://mystore.com",
+    "currency": "USD"
+  },
+  "capabilities": {
+    "catalog": true,
+    "search": true,
+    "cart": true,
+    "checkout": "redirect"
+  }
+}
+```

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+
+export {  }