{"_id":"@apariva/cli","_rev":"2-e3b0bd890e29986517ea4d4d98409064","name":"@apariva/cli","dist-tags":{"latest":"0.1.1"},"versions":{"0.1.0":{"name":"@apariva/cli","version":"0.1.0","keywords":["apariva","cli","api","task-management","document-management"],"author":{"name":"Apariva"},"license":"MIT","_id":"@apariva/cli@0.1.0","maintainers":[{"name":"praj.k","email":"praj@apariva.ai"}],"bin":{"apv":"dist/index.js"},"dist":{"shasum":"29cfb996ef50432d7bd26602a96ba4853d6cc285","tarball":"https://registry.npmjs.org/@apariva/cli/-/cli-0.1.0.tgz","fileCount":6,"integrity":"sha512-KP33XTuHDckpulU9YL5zp7jHwwiKbyhD8PZXR4pQNQyu8o0KJqJUuy/sN/kTL3yUXjfEMabC8baSRh8Uw8D7ng==","signatures":[{"sig":"MEUCIQCx0k2wJ+x/EnPABk3L8Jwx4ct1Y5zwkRa+XQy4RrlWDAIgI2TjpfTVkAutP9GPEbYpMO4xp9MEsmnVHBIBFaE/pHo=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":103346},"main":"./dist/index.js","type":"module","_from":"file:apariva-cli-0.1.0.tgz","types":"./dist/index.d.ts","engines":{"node":">=18.0.0"},"scripts":{"dev":"tsup --watch","lint":"eslint src","test":"vitest","build":"tsup","typecheck":"tsc --noEmit"},"_npmUser":{"name":"praj.k","email":"praj@apariva.ai"},"_resolved":"/private/var/folders/dj/lz2k4ttj40z5hdtd6s1wyd6h0000gn/T/ae1cab1c2f3ca6c8ab33487a8037a614/apariva-cli-0.1.0.tgz","_integrity":"sha512-KP33XTuHDckpulU9YL5zp7jHwwiKbyhD8PZXR4pQNQyu8o0KJqJUuy/sN/kTL3yUXjfEMabC8baSRh8Uw8D7ng==","_npmVersion":"11.4.2","description":"CLI tool for interacting with Apariva APIs","directories":{},"_nodeVersion":"22.16.0","dependencies":{"ora":"^8.1.1","conf":"^13.0.1","chalk":"^5.3.0","inquirer":"^11.1.0","commander":"^12.1.0","cli-table3":"^0.6.5"},"_hasShrinkwrap":false,"devDependencies":{"tsup":"^8.3.5","vitest":"^2.1.5","typescript":"^5.6.3","@types/node":"^20.17.6","@types/inquirer":"^9.0.7"},"_npmOperationalInternal":{"tmp":"tmp/cli_0.1.0_1762194444218_0.7336392074754248","host":"s3://npm-registry-packages-npm-production"}},"0.1.1":{"name":"@apariva/cli","version":"0.1.1","description":"CLI tool for interacting with Apariva APIs","type":"module","main":"./dist/index.js","bin":{"apv":"dist/index.js"},"keywords":["apariva","cli","api","task-management","document-management"],"author":{"name":"Apariva"},"license":"MIT","engines":{"node":">=18.0.0"},"dependencies":{"commander":"^12.1.0","inquirer":"^11.1.0","chalk":"^5.3.0","ora":"^8.1.1","cli-table3":"^0.6.5","conf":"^13.0.1"},"devDependencies":{"@types/node":"^20.17.6","@types/inquirer":"^9.0.7","tsup":"^8.3.5","typescript":"^5.6.3","vitest":"^2.1.5"},"scripts":{"build":"tsup","dev":"tsup --watch","typecheck":"tsc --noEmit","test":"vitest","lint":"eslint src"},"_id":"@apariva/cli@0.1.1","types":"./dist/index.d.ts","_integrity":"sha512-/a+mxAtsy26ysWWmpc+ceflR15PePEkjeXRWbZtR6Dpkmgbp3by8N5jJWqLxXlNTL9c3+m6IoAAwpZpu4DMxhQ==","_resolved":"/private/var/folders/dj/lz2k4ttj40z5hdtd6s1wyd6h0000gn/T/12c632df6093c777a67c034af094ea1d/apariva-cli-0.1.1.tgz","_from":"file:apariva-cli-0.1.1.tgz","_nodeVersion":"22.16.0","_npmVersion":"11.4.2","dist":{"integrity":"sha512-/a+mxAtsy26ysWWmpc+ceflR15PePEkjeXRWbZtR6Dpkmgbp3by8N5jJWqLxXlNTL9c3+m6IoAAwpZpu4DMxhQ==","shasum":"5d14af53d3f7cee52925054e4e2b04edce68e615","tarball":"https://registry.npmjs.org/@apariva/cli/-/cli-0.1.1.tgz","fileCount":6,"unpackedSize":103343,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQDmPeeeyugBbT+shv0P7m1b3tigJ1dDGy5Rg3vI7I7ufAIhANmjfCoOyunfBbZW+M7kaFoVRo6azvVPgcAbAmQQlA9T"}]},"_npmUser":{"name":"praj.k","email":"praj@apariva.ai"},"directories":{},"maintainers":[{"name":"praj.k","email":"praj@apariva.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/cli_0.1.1_1762194570754_0.14123644710197225"},"_hasShrinkwrap":false}},"time":{"created":"2025-11-03T18:27:24.121Z","modified":"2025-11-03T18:29:31.730Z","0.1.0":"2025-11-03T18:27:24.405Z","0.1.1":"2025-11-03T18:29:30.957Z"},"author":{"name":"Apariva"},"license":"MIT","keywords":["apariva","cli","api","task-management","document-management"],"description":"CLI tool for interacting with Apariva APIs","maintainers":[{"name":"praj.k","email":"praj@apariva.ai"}],"readme":"# @apariva/cli\n\nOfficial command-line interface for interacting with Apariva APIs.\n\n## Installation\n\n```bash\n# Install globally\nnpm install -g @apariva/cli\n\n# Or use with npx (no installation required)\nnpx @apariva/cli --help\n```\n\n**Command name:** `apv` (short for Apariva)\n\n## Quick Start\n\n### 1. Get an API Key\n\nFirst, create an API key from your Apariva dashboard:\n1. Log in to [apariva.ai](https://apariva.ai)\n2. Navigate to Settings → API Keys\n3. Click \"Create API Key\"\n4. Copy the key (it will only be shown once!)\n\n### 2. Login\n\n```bash\napv login\n# You'll be prompted to enter your API key\n\n# Or provide it directly\napv login --api-key apv_prod_xxxxxxxxxxxxxxxx\n```\n\n### 3. Verify Authentication\n\n```bash\napv whoami\n```\n\n## Commands\n\n### Authentication\n\n```bash\n# Login with API key\napv login [--api-key KEY]\n\n# Logout and clear credentials\napv logout\n\n# Display current user information\napv whoami\n```\n\n### Configuration\n\n```bash\n# Set API endpoint (for development/staging)\napv config set-endpoint https://apariva.ai\n\n# Get current API endpoint\napv config get-endpoint\n```\n\n### Project Management\n\n```bash\n# List all projects\napv projects list\n\n# Get project details\napv projects get <project-id>\n\n# Create a new project\napv projects create \"My Project\" \\\n  --description \"Project description\" \\\n  --status active\n\n# Update a project\napv projects update <project-id> \\\n  --name \"Updated Name\" \\\n  --status completed\n\n# Delete a project\napv projects delete <project-id> --force\n```\n\n### Task Management\n\n```bash\n# List all tasks\napv tasks list\n\n# List tasks for a specific project\napv tasks list --project <project-id>\n\n# Get task details\napv tasks get <task-id>\n\n# Create a new task\napv tasks create \"Task Title\" \\\n  --project <project-id> \\\n  --description \"Task description\" \\\n  --priority high \\\n  --status todo\n\n# Update a task\napv tasks update <task-id> \\\n  --title \"Updated Title\" \\\n  --status in-progress \\\n  --priority medium\n\n# Delete a task\napv tasks delete <task-id> --force\n```\n\n### Document Management (DMS)\n\n```bash\n# List documents\napv dms list\n\n# List with filters\napv dms list \\\n  --document-type invoice \\\n  --category financial \\\n  --limit 20\n\n# Get document details\napv dms get <document-id>\n\n# Upload a document\napv dms upload /path/to/file.pdf \\\n  --document-type invoice \\\n  --category financial \\\n  --description \"Q1 2024 Invoice\" \\\n  --tags \"client-a,2024\" \\\n  --extract\n\n# Upload with AI extraction using templates\napv dms upload /path/to/invoice.pdf \\\n  --extract \\\n  --templates template_xxx,template_yyy\n\n# Download a document\napv dms download <document-id> \\\n  --output /path/to/save/file.pdf\n\n# Trigger document processing/extraction\napv dms process <document-id> \\\n  --templates template_xxx\n\n# Delete a document\napv dms delete <document-id> --force\n```\n\n## API Key Scopes\n\nAPI keys can have different permission scopes:\n\n- `tasks:read` - List and view tasks\n- `tasks:write` - Create and update tasks\n- `tasks:delete` - Delete tasks\n- `projects:read` - List and view projects\n- `projects:write` - Create and update projects\n- `projects:delete` - Delete projects\n- `dms:read` - List and download documents\n- `dms:write` - Upload documents\n- `dms:process` - Trigger document processing/extraction\n- `dms:delete` - Delete documents\n- `*` - All permissions (admin)\n\nWhen creating an API key in the dashboard, you can select which scopes to grant.\n\n## Configuration File\n\nThe CLI stores configuration in `~/.apariva/config.json`:\n\n```json\n{\n  \"apiKey\": \"apv_prod_...\",\n  \"endpoint\": \"https://apariva.ai\",\n  \"userId\": \"user_xxx\",\n  \"userEmail\": \"user@example.com\"\n}\n```\n\n**Security Note:** This file contains your API key. Keep it secure and never commit it to version control.\n\n## Examples\n\n### Create a project and add tasks\n\n```bash\n# Create a project\nPROJECT_ID=$(apv projects create \"Website Redesign\" \\\n  --description \"Redesign company website\" \\\n  --status active | grep \"ID:\" | cut -d' ' -f2)\n\n# Create tasks for the project\napv tasks create \"Design mockups\" \\\n  --project $PROJECT_ID \\\n  --priority high\n\napv tasks create \"Implement frontend\" \\\n  --project $PROJECT_ID \\\n  --priority medium\n\napv tasks create \"Deploy to production\" \\\n  --project $PROJECT_ID \\\n  --priority low\n```\n\n### Upload and process invoices\n\n```bash\n# Upload multiple invoices with AI extraction\nfor file in invoices/*.pdf; do\n  apv dms upload \"$file\" \\\n    --document-type invoice \\\n    --category financial \\\n    --extract \\\n    --templates template_financial_data\ndone\n\n# List all invoices\napv dms list --document-type invoice\n```\n\n### Bulk download documents\n\n```bash\n# Download all documents in a category\napv dms list --category financial --limit 100 | \\\n  grep -oP 'doc_[a-f0-9-]+' | \\\n  while read doc_id; do\n    apv dms download \"$doc_id\" --output \"backup/$doc_id.pdf\"\n  done\n```\n\n## Environment Variables\n\nYou can override the default endpoint using an environment variable:\n\n```bash\nexport APARIVA_ENDPOINT=https://staging.apariva.ai\napv whoami\n```\n\n## Development\n\n### Building from Source\n\n```bash\n# Clone the repository\ngit clone https://github.com/apariva/apariva-ai-site.git\ncd apariva-ai-site/packages/cli\n\n# Install dependencies\npnpm install\n\n# Build the CLI\npnpm run build\n\n# Link for local testing\nnpm link\n\n# Use the CLI\napv --help\n```\n\n### Testing\n\n```bash\n# Run tests\npnpm test\n\n# Watch mode\npnpm test:watch\n```\n\n## Troubleshooting\n\n### \"Not authenticated\" error\n\nMake sure you've run `apv login` and provided a valid API key.\n\n```bash\napv login --api-key apv_prod_xxxxxxxxxxxxxxxx\napv whoami  # Verify authentication\n```\n\n### Invalid API key\n\nIf you get an \"Invalid API key\" error:\n1. Check that your API key is still active in the dashboard\n2. Verify the key hasn't expired\n3. Ensure the key has the required scopes for the operation\n\n### Command not found\n\nIf `apv` command is not found after installation:\n1. Make sure your npm global bin directory is in your PATH\n2. Try using `npx @apariva/cli` instead\n3. Reinstall: `npm install -g @apariva/cli`\n\n## Support\n\n- Documentation: https://docs.apariva.ai\n- Issues: https://github.com/apariva/apariva-ai-site/issues\n- Email: info@apariva.ai\n\n## License\n\nMIT\n","readmeFilename":"README.md"}