@optima-chat/scout-cli 0.1.5 → 0.1.7

package/README.md

@@ -1,274 +1,96 @@
 # Optima Scout CLI
 
-Command-line interface for Optima Scout - AI-powered Amazon product research tool.
-
-**Designed for LLM consumption** - optimized for Claude Code and other AI assistants.
-
-## Features
-
-- **JSON Output**: Default structured JSON output for easy LLM parsing
-- **Non-Interactive**: No spinners, prompts, or colored output by default
-- **Simple Text Mode**: Optional plain text format for human readability
-- **Fast**: Leverages backend caching for quick responses
-
-## Prerequisites
-
-- Node.js >= 20.0.0
-- Optima Scout API running (default: `http://localhost:3000`)
+AI-powered Amazon product research tool for Claude Code and LLMs.
 
 ## Installation
 
-### From Source
-
 ```bash
-# Install dependencies
-npm install
-
-# Run in development mode
-npm run dev <command>
-
-# Or build and use globally
-npm run build
-npm link
-scout <command>
+npm install -g @optima-chat/scout-cli
 ```
 
-## Usage
-
-### Initialize Claude Code Skills
-
-Initialize Optima Scout Skills in your project for Claude Code integration:
+## Quick Start
 
 ```bash
+# Initialize Claude Code skills
 scout init
-```
-
-This creates `.claude/skills/` directory with `search.json` and `product.json` configurations.
-
-**Options:**
-- `-f, --force` - Overwrite existing skills
 
-**Example:**
-```bash
-# First time setup
-cd your-project
-scout init
+# Search products
+scout search "coffee maker"
 
-# Update skills configuration
-scout init --force
+# Get product details
+scout product B01GJOMWVA
 ```
 
-After initialization, you can use Optima Scout in Claude Code:
-```
-帮我搜索一下 "wireless mouse"
-```
+## Commands
 
----
+### `scout init`
 
-### Search Products
+Initialize Optima Scout skills for Claude Code.
 
-Search for products on Amazon with JSON output (default):
+**Options:**
+- `-f, --force` - Overwrite existing skills
 
-```bash
-scout search "coffee maker"
-```
+### `scout search <query>`
 
-**Output (JSON)**:
-```json
-{
-  "results": [
-    {
-      "position": 1,
-      "title": "BLACK+DECKER 12-Cup Digital Coffee Maker...",
-      "asin": "B01GJOMWVA",
-      "price": { "value": 40.99, "currency": "USD" },
-      "rating": 4.4,
-      "ratings_total": 46754,
-      "recent_sales": "10K+ bought in past month"
-    }
-  ],
-  "metadata": {
-    "total_results": 48,
-    "shown_results": 10,
-    "cached": false,
-    "credits_remaining": 89
-  }
-}
-```
+Search Amazon products with structured JSON output.
 
 **Options:**
 - `-d, --domain <domain>` - Amazon domain (default: `amazon.com`)
-- `-l, --limit <number>` - Limit results (default: `10`)
-- `-f, --format <format>` - Output format: `json` (default) or `text`
-
-**Examples:**
+- `-l, --limit <number>` - Result limit (default: `10`)
+- `-f, --format <format>` - Output: `json` | `text`
 
+**Example:**
 ```bash
-# JSON output (default) - for LLMs
-scout search "coffee maker" --limit 5
-
-# Text output - for humans
-scout search "coffee maker" --limit 5 --format text
+scout search "wireless mouse" --limit 5 --format json
 ```
 
-**Text Output**:
-```
-B01GJOMWVA	BLACK+DECKER 12-Cup Digital Coffee Maker...	40.99	4.4	46754	10K+ bought in past month
-B0C8B9V7HR	BLACK+DECKER 12-Cup Coffee Maker...	28.67	4.3	18851	20K+ bought in past month
-```
-
-### Get Product Details
+### `scout product <asin>`
 
-Get detailed information about a specific product (JSON by default):
-
-```bash
-scout product B01GJOMWVA
-```
-
-**Output (JSON)**:
-```json
-{
-  "product": {
-    "asin": "B01GJOMWVA",
-    "title": "BLACK+DECKER 12-Cup Digital Coffee Maker...",
-    "brand": "BLACK+DECKER",
-    "buybox_winner": {
-      "price": { "value": 40.99, "currency": "USD" },
-      "new_offers_count": 2
-    },
-    "recent_sales": "10K+ bought in past month",
-    "rating": 4.4,
-    "ratings_total": 46754,
-    "rating_breakdown": {
-      "five_star": { "percentage": 70, "count": 32727 },
-      "one_star": { "percentage": 7, "count": 3272 }
-    },
-    "top_reviews": [ /* array of reviews */ ],
-    "specifications": [ /* array of specs including BSR */ ]
-  },
-  "metadata": {
-    "cached": true,
-    "credits_remaining": 90
-  }
-}
-```
+Get detailed product information.
 
 **Options:**
 - `-d, --domain <domain>` - Amazon domain (default: `amazon.com`)
-- `-f, --format <format>` - Output format: `json` (default) or `text`
+- `-f, --format <format>` - Output: `json` | `text`
 
-**Text Output**:
-```
-ASIN: B01GJOMWVA
-Title: BLACK+DECKER 12-Cup Digital Coffee Maker...
-Brand: BLACK+DECKER
-Price: $40.99
-Sellers: 2
-Recent Sales: 10K+ bought in past month
-Rating: 4.4
-Reviews: 46754
-BSR: #530 in Home & Kitchen #2 in Coffee Machines
+**Example:**
+```bash
+scout product B004YAVF8I --domain amazon.com
 ```
 
 ## Configuration
 
-Create a `.env` file:
+Set API endpoint via environment variable:
 
 ```bash
-cp .env.example .env
+export API_URL=http://dev.optima.sh:3000
 ```
 
-Edit `.env`:
+Or create `.env` file:
 
 ```env
 API_URL=http://localhost:3000
 ```
 
-## LLM Integration
-
-This CLI is designed for Claude Code and other LLM tools:
-
-### Key Features for LLMs
-
-1. **Structured JSON Output**: All data returned in parseable JSON by default
-2. **No Interactive Elements**: No spinners, colors, or prompts
-3. **Complete Data**: Full product information in single response
-4. **Error Handling**: Errors also returned as JSON
-
-### Example LLM Usage
+## Features
 
-```typescript
-// Claude Code can call:
-const result = await exec('scout search "coffee maker" --limit 5');
-const data = JSON.parse(result);
-
-// Access structured data
-data.results.forEach(product => {
-  console.log(product.asin, product.title, product.recent_sales);
-});
-```
+- **JSON-first**: Structured output optimized for LLM parsing
+- **Non-interactive**: No spinners, prompts, or colors
+- **Fast**: Backend caching for quick responses
+- **Claude Code integration**: Auto-discovery via skills
 
 ## Development
 
-### Project Structure
-
-```
-cli/
-├── src/
-│   ├── commands/        # CLI commands
-│   │   ├── search.ts    # Search command
-│   │   └── product.ts   # Product command
-│   ├── types/           # TypeScript types
-│   │   └── api.ts       # API response types
-│   ├── utils/           # Utilities
-│   │   ├── api.ts       # API client
-│   │   └── config.ts    # Configuration
-│   └── index.ts         # Entry point
-├── package.json
-└── tsconfig.json
-```
-
-### Scripts
-
 ```bash
-# Development mode
-npm run dev <command>
+# Install dependencies
+npm install
 
-# Build TypeScript
+# Build
 npm run build
 
-# Type checking
-npm run type-check
-
-# Lint code
-npm run lint
+# Link locally
+npm link
 ```
 
-## Output Formats
-
-### JSON Format (Default)
-
-- **Purpose**: LLM consumption
-- **Benefits**:
-  - Easy to parse programmatically
-  - Complete data structure
-  - No formatting noise
-  - Metadata included (caching, credits)
-
-### Text Format
-
-- **Purpose**: Human readability
-- **Benefits**:
-  - Quick visual scanning
-  - Tab-separated values (easy to parse)
-  - Minimal but informative
-
-## Tech Stack
-
-- **Commander.js** - CLI framework
-- **TypeScript** - Type safety
-- **Minimal Dependencies** - Only essential packages
-
 ## License
 
 MIT

package/dist/index.js

@@ -1,13 +1,16 @@
 #!/usr/bin/env node
+import { createRequire } from 'module';
 import { Command } from 'commander';
 import { searchCommand } from './commands/search.js';
 import { productCommand } from './commands/product.js';
 import { initCommand } from './commands/init.js';
+const require = createRequire(import.meta.url);
+const packageJson = require('../package.json');
 const program = new Command();
 program
     .name('scout')
     .description('Optima Scout - AI-powered Amazon product research tool')
-    .version('0.1.0');
+    .version(packageJson.version);
 // Register commands
 program.addCommand(initCommand);
 program.addCommand(searchCommand);

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;AAE9B,OAAO;KACJ,IAAI,CAAC,OAAO,CAAC;KACb,WAAW,CAAC,wDAAwD,CAAC;KACrE,OAAO,CAAC,OAAO,CAAC,CAAC;AAEpB,oBAAoB;AACpB,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;AAChC,OAAO,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;AAClC,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;AAEnC,kBAAkB;AAClB,OAAO,CAAC,KAAK,EAAE,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC/C,MAAM,WAAW,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;AAE/C,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;AAE9B,OAAO;KACJ,IAAI,CAAC,OAAO,CAAC;KACb,WAAW,CAAC,wDAAwD,CAAC;KACrE,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;AAEhC,oBAAoB;AACpB,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;AAChC,OAAO,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;AAClC,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;AAEnC,kBAAkB;AAClB,OAAO,CAAC,KAAK,EAAE,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@optima-chat/scout-cli",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "description": "AI-powered Amazon product research CLI tool - Search products and get detailed analytics",
   "type": "module",
   "main": "dist/index.js",