@kat-ai/cli 0.1.0

package/README.md

@@ -0,0 +1,212 @@
+# @kat-ai/cli
+
+Knowledge Base Tools CLI - A unified command-line interface for managing Pinecone knowledge bases.
+
+## Installation
+
+### From npm (when published)
+
+```bash
+npm install -g @kat-ai/cli
+```
+
+Introspection + Eval baseline package set:
+
+```bash
+npm install @kat-ai/sdk@0.1.0 @kat-ai/eval@0.1.0 @kat-ai/cli@0.1.0
+```
+
+### From source
+
+```bash
+# Clone the repository
+git clone https://github.com/pinecone-io/kat.git
+cd kat
+
+# Install dependencies
+pnpm install
+
+# Build the CLI
+pnpm cli:build
+
+# Link for global usage
+cd packages/cli
+npm link
+```
+
+## Usage
+
+### Interactive Mode
+
+Run without arguments to enter interactive mode:
+
+```bash
+kat
+```
+
+### Commands
+
+#### Ingest Data
+
+Ingest CSV data into Pinecone assistants with topic extraction:
+
+```bash
+# Interactive mode
+kat ingest -i
+
+# Direct mode
+kat ingest --output pinecone
+kat ingest --output local --dir ./data/ingested
+kat ingest --output both --dry-run
+```
+
+Options:
+- `-o, --output <mode>` - Output mode: pinecone, local, or both (default: pinecone)
+- `-d, --dir <path>` - Local output directory for ingested files
+- `--dry-run` - Preview changes without making them
+- `-i, --interactive` - Run in interactive mode
+
+#### Compose Manifest
+
+Build KB manifests with AI assistance:
+
+```bash
+# Interactive mode
+kat compose -i
+
+# Direct mode
+kat compose --kb-id my_kb --domain support --description "Support KB"
+kat compose --kb-id my_kb --source ./data/faq.csv --storage both
+```
+
+Options:
+- `--kb-id <id>` - KB identifier
+- `--domain <domain>` - Domain name
+- `--description <desc>` - Short description
+- `--assistant <name>` - Pinecone assistant name
+- `--source <path>` - Path to source CSV data
+- `-s, --storage <mode>` - Storage mode: local, pinecone, or both
+- `--dry-run` - Preview without saving
+
+#### Introspect Assistant
+
+Generate manifest from existing Pinecone assistant:
+
+```bash
+# Interactive mode
+kat introspect -i
+
+# Direct mode
+kat introspect --assistant my-assistant --kb-id my_kb
+kat introspect --assistant my-assistant --storage both --verbose
+```
+
+Options:
+- `-a, --assistant <name>` - Pinecone assistant name
+- `--kb-id <id>` - KB identifier
+- `--domain <domain>` - Domain name
+- `-s, --storage <mode>` - Storage mode
+- `--verbose` - Show detailed Q&A during introspection
+- `--dry-run` - Preview without saving
+
+#### Validate Data
+
+Validate CSV data against KB definitions:
+
+```bash
+# Interactive mode
+kat validate -i
+
+# Direct mode
+kat validate
+kat validate --path ./data
+kat validate --json
+```
+
+Options:
+- `-p, --path <path>` - Path to CSV file or directory
+- `--json` - Output results as JSON
+
+#### Test Topics
+
+Test topic extraction on files:
+
+```bash
+# Interactive mode
+kat topics -i
+
+# Direct mode
+kat topics ./data/document.txt
+kat topics ./data/*.csv --mode slm --top-n 10
+kat topics ./docs --mode hybrid --verbose
+```
+
+Options:
+- `-m, --mode <mode>` - Extraction mode: classic (TF-IDF), slm (LLM), or hybrid
+- `-n, --top-n <n>` - Number of topics per document (default: 5)
+- `--verbose` - Show document previews
+- `--json` - Output as JSON
+
+#### Sync Manifests
+
+Sync manifests between local files and Pinecone:
+
+```bash
+# Interactive mode
+kat sync -i
+
+# Direct mode
+kat sync --direction toLocal
+kat sync --direction toPinecone
+kat sync --direction both --dry-run
+```
+
+Options:
+- `-d, --direction <dir>` - Sync direction: toLocal, toPinecone, or both
+- `--dry-run` - Preview changes without making them
+
+### Global Options
+
+- `-v, --version` - Display version number
+- `--no-color` - Disable colored output
+- `--verbose` - Enable verbose output
+- `-h, --help` - Display help
+
+## Environment Variables
+
+Create a `.env.local` file with the following variables:
+
+```env
+PINECONE_API_KEY=your-pinecone-api-key
+OPENAI_API_KEY=your-openai-api-key
+```
+
+The CLI will automatically look for `.env.local` in the current directory and parent directories.
+
+## Development
+
+### Build
+
+```bash
+pnpm cli:build
+```
+
+### Development Mode (watch)
+
+```bash
+pnpm cli:dev
+```
+
+### Run locally
+
+```bash
+# After building
+node packages/cli/dist/index.js
+
+# Or with tsx (development)
+pnpm cli:legacy
+```
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1 @@
+#!/usr/bin/env node