@toothfairyai/cli 1.0.3 → 1.0.7

package/README.md

@@ -4,9 +4,9 @@ A Node.js command-line interface for interacting with ToothFairy AI agents.
 
 ## Installation
 
-### From NPM (when published)
+### From NPM
 ```bash
-npm install -g toothfairy-cli
+npm install -g @toothfairyai/cli
 ```
 
 ### From Source
@@ -22,8 +22,6 @@ npm link  # Makes 'toothfairy' command available globally
 1. **Configure your credentials:**
 ```bash
 toothfairy configure \
-  --base-url "https://api.toothfairyai.com" \
-  --ai-url "https://ai.toothfairyai.com" \
   --api-key "your-api-key" \
   --workspace-id "your-workspace-id"
 ```
@@ -31,18 +29,183 @@ toothfairy configure \
 2. **Send a message to an agent:**
 ```bash
 toothfairy send "Hello, I need help with my appointment" \
-  --agent-id "agent-123" \
-  --phone-number "+1234567890" \
-  --customer-id "customer-456" \
-  --provider-id "sms-provider-789"
+  --agent-id "agent-123"
 ```
 
-3. **List your chats:**
+3. **Search the knowledge hub:**
+```bash
+toothfairy search "appointment scheduling help"
+```
+
+4. **List your chats:**
 ```bash
 toothfairy chats
 ```
 
-For full documentation, see the main [README.md](../README.md) in the parent directory.
+## Available Commands
+
+### Global Options
+- `-c, --config <path>`: Path to configuration file
+- `-v, --verbose`: Enable verbose logging
+
+### Commands
+
+#### `configure`
+Configure ToothFairy CLI credentials and settings.
+
+**Options:**
+- `--api-key <key>`: API key (required)
+- `--workspace-id <id>`: Workspace ID (required)
+- `--base-url <url>`: ToothFairy API base URL (optional, defaults to production)
+- `--ai-url <url>`: ToothFairy AI URL (optional, defaults to production)
+- `--config-path <path>`: Custom path to save config file
+
+**Example:**
+```bash
+toothfairy configure --api-key "your-key" --workspace-id "your-workspace"
+```
+
+#### `send <message>`
+Send a message to a ToothFairy AI agent.
+
+**Arguments:**
+- `message`: The message text to send
+
+**Options:**
+- `--agent-id <id>`: Agent ID to send message to (required)
+- `--phone-number <number>`: Phone number for SMS channel (optional)
+- `--customer-id <id>`: Customer ID (optional)
+- `--provider-id <id>`: SMS provider ID (optional)
+- `--customer-info <json>`: Customer info as JSON string (optional)
+- `-o, --output <format>`: Output format (json|text, default: text)
+- `-v, --verbose`: Show detailed response information
+
+**Examples:**
+```bash
+# Simple message
+toothfairy send "What are your hours?" --agent-id "info-agent"
+
+# With customer information
+toothfairy send "Schedule appointment" \
+  --agent-id "scheduler" \
+  --customer-info '{"name": "John", "phone": "+1234567890"}'
+
+# With verbose output
+toothfairy send "Hello" --agent-id "agent-123" --verbose
+```
+
+#### `search <query>`
+Search for documents in the knowledge hub.
+
+**Arguments:**
+- `query`: The search query text
+
+**Options:**
+- `-k, --top-k <number>`: Number of documents to retrieve (1-50, default: 10)
+- `--status <status>`: Filter by document status (published|suspended)
+- `--document-id <id>`: Search within specific document ID
+- `--topics <topics>`: Comma-separated topic IDs to filter by
+- `-o, --output <format>`: Output format (json|text, default: text)
+- `-v, --verbose`: Show detailed search information
+
+**Examples:**
+```bash
+# Basic search
+toothfairy search "AI agent configuration"
+
+# Filter by status and limit results
+toothfairy search "machine learning" --status published --top-k 5
+
+# Search with topic filtering
+toothfairy search "automation" --topics "topic_123,topic_456"
+
+# Verbose search with JSON output
+toothfairy search "deployment" --verbose --output json
+```
+
+#### `chats`
+List all chats in the workspace.
+
+**Options:**
+- `-o, --output <format>`: Output format (json|text, default: text)
+
+**Example:**
+```bash
+toothfairy chats
+toothfairy chats --output json
+```
+
+#### `chat <chat-id>`
+Get details of a specific chat.
+
+**Arguments:**
+- `chat-id`: The chat ID to retrieve
+
+**Options:**
+- `-o, --output <format>`: Output format (json|text, default: text)
+
+**Example:**
+```bash
+toothfairy chat "chat-abc123"
+```
+
+#### `config-show`
+Display current configuration (with masked API key).
+
+**Example:**
+```bash
+toothfairy config-show
+```
+
+#### `help-guide`
+Show detailed help with examples, common issues, and pro tips.
+
+**Example:**
+```bash
+toothfairy help-guide
+```
+
+## Configuration
+
+The CLI supports multiple configuration methods (in order of priority):
+
+1. **Environment variables:**
+```bash
+export TF_API_KEY="your-api-key"
+export TF_WORKSPACE_ID="your-workspace-id"
+export TF_BASE_URL="https://api.toothfairyai.com"  # optional
+export TF_AI_URL="https://ai.toothfairyai.com"     # optional
+```
+
+2. **Config file at `~/.toothfairy/config.yml`:**
+```yaml
+api_key: "your-api-key"
+workspace_id: "your-workspace-id"
+base_url: "https://api.toothfairyai.com"  # optional
+ai_url: "https://ai.toothfairyai.com"     # optional
+```
+
+3. **CLI arguments:**
+```bash
+toothfairy --config /path/to/config.yml send "Hello" --agent-id "agent-123"
+```
+
+## Output Formats
+
+Both `json` and `text` output formats are supported:
+
+- **`text`** (default): Pretty formatted tables and panels
+- **`json`**: Raw JSON output for scripting
+
+```bash
+# Get JSON output for scripting
+toothfairy send "Hello" --agent-id "agent-123" --output json | jq '.agentResponse.contents.content'
+
+# Search with JSON output
+toothfairy search "documentation" --output json | jq '.[].title'
+```
+
+For full documentation and cross-platform examples, see the main [README.md](../README.md) in the parent directory.
 
 ## Development