{"_id":"@codebox.club/cli","name":"@codebox.club/cli","dist-tags":{"latest":"0.1.0"},"versions":{"0.1.0":{"name":"@codebox.club/cli","version":"0.1.0","description":"Official CLI for CodeBox QR code platform","bin":{"codebox":"dist/index.js"},"scripts":{"build":"tsup","dev":"tsup --watch","typecheck":"tsc --noEmit"},"keywords":["codebox","qrcode","cli","qr-code"],"author":{"name":"CodeBox","email":"freecloud@emong.com.cn"},"homepage":"https://www.codebox.club/docs/cli","repository":{"type":"git","url":"git+https://github.com/codebox-club/codebox.git","directory":"packages/cli"},"engines":{"node":">=18"},"dependencies":{"@codebox.club/sdk":"^0.1.0","commander":"^12.0.0"},"devDependencies":{"@types/node":"^20.0.0","tsup":"^8.0.0","typescript":"^5.0.0"},"license":"MIT","_id":"@codebox.club/cli@0.1.0","gitHead":"4138b3848c0da9d03ab0b390303f39adb6ecd395","bugs":{"url":"https://github.com/codebox-club/codebox/issues"},"_nodeVersion":"22.16.0","_npmVersion":"10.9.2","dist":{"integrity":"sha512-rby13f5Q+w3Ca98hOJ3zSihTy+lkIQkPBWQwp+QC0gLgbhNJ9lqaeyZOOQPhrjBALOEC7Y/0ceybBVPmOFRmoQ==","shasum":"54d75bcbce462449dc61d0dba5a6e924bb889d3e","tarball":"https://registry.npmjs.org/@codebox.club/cli/-/cli-0.1.0.tgz","fileCount":4,"unpackedSize":75763,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQCfgOCMt/h/EjmqE9vX800buEpvRKBe5vulaHLKyxUvmQIhAPpzYCxYL5b84XYjHGBdCI6RklsDzgEcM3maQUbbu8mx"}]},"_npmUser":{"name":"kajian","email":"929932952@qq.com"},"directories":{},"maintainers":[{"name":"kajian","email":"929932952@qq.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/cli_0.1.0_1774339755817_0.5508328159389544"},"_hasShrinkwrap":false}},"time":{"created":"2026-03-24T08:09:15.733Z","0.1.0":"2026-03-24T08:09:15.949Z","modified":"2026-03-24T08:09:16.163Z"},"maintainers":[{"name":"kajian","email":"929932952@qq.com"}],"description":"Official CLI for CodeBox QR code platform","homepage":"https://www.codebox.club/docs/cli","keywords":["codebox","qrcode","cli","qr-code"],"repository":{"type":"git","url":"git+https://github.com/codebox-club/codebox.git","directory":"packages/cli"},"author":{"name":"CodeBox","email":"freecloud@emong.com.cn"},"bugs":{"url":"https://github.com/codebox-club/codebox/issues"},"license":"MIT","readme":"# @codebox.club/cli\n\nOfficial CLI for the [CodeBox](https://www.codebox.club) QR code platform.\n\n## Installation\n\n```bash\nnpm install -g @codebox.club/cli\n# or\npnpm add -g @codebox.club/cli\n```\n\n## Quick Start\n\n```bash\n# Set your API key (get one at https://www.codebox.club/dashboard/apikeys)\ncodebox config set api-key cb_sk_your_key_here\n\n# Create a QR code\ncodebox qr create \"https://example.com\" --mode DYNAMIC --name \"My QR\"\n\n# List your QR codes\ncodebox qr list\n\n# View scan analytics\ncodebox qr stats \n\n# Browse templates\ncodebox template list\ncodebox template search \"tech\"\n```\n\n## Authentication\n\nAPI key is resolved in this order:\n1. `--api-key` flag\n2. `CODEBOX_API_KEY` environment variable\n3. `~/.codeboxrc` config file\n\n```bash\n# Option 1: Config file (recommended for local dev)\ncodebox config set api-key cb_sk_xxx\n\n# Option 2: Environment variable (recommended for CI)\nexport CODEBOX_API_KEY=cb_sk_xxx\n\n# Option 3: Flag (one-off)\ncodebox --api-key cb_sk_xxx qr list\n```\n\n## Commands\n\n### QR Codes\n\n```bash\ncodebox qr create # Create a QR code\n -m, --mode # Default: DYNAMIC\n -t, --template # Template ID\n -k, --keywords # Keywords for template matching\n -n, --name # Name\n --logo # Logo URL\n --size # Size in pixels\n -e, --error-level # Error correction level\n\ncodebox qr list # List QR codes\n -p, --page # Page (default: 1)\n -s, --size # Page size (default: 10)\n -m, --mode # Filter: STATIC, DYNAMIC, AI\n -k, --keyword # Filter by keyword\n\ncodebox qr stats # Scan analytics\n --start-date \n --end-date \n\ncodebox qr update # Update QR code\n -u, --url \n -n, --name \n --status \n\ncodebox qr delete # Delete QR code\n -f, --force # Skip confirmation\n\ncodebox qr clone # Clone QR code\n -n, --name \n -c, --content \n\ncodebox qr scans # List scan events\n -p, --page \n -s, --size \n --start-date \n --end-date \n\ncodebox qr batch # Batch create from JSON (max 20)\n```\n\n### Templates\n\n```bash\ncodebox template list # List all templates\n -c, --category # Filter by category\n\ncodebox template search # Search templates\n```\n\n### Webhooks\n\n```bash\ncodebox webhook create # Create webhook\n --events # Default: scan.created, qrcode.created\n\ncodebox webhook list # List webhooks\ncodebox webhook update # Update webhook\ncodebox webhook delete # Delete webhook\n```\n\n### Config\n\n```bash\ncodebox config set # Set api-key or base-url\ncodebox config get # Get config value\ncodebox config list # Show all config\ncodebox config unset # Remove config value\n```\n\n### Global Options\n\n```bash\n--api-key # Override API key\n--base-url # Override API base URL\n--json # Output as JSON (machine-readable)\n--version # Show version\n--help # Show help\n```\n\n## JSON Output\n\nAll commands support `--json` for machine-readable output:\n\n```bash\ncodebox qr list --json | jq '.data[].id'\ncodebox qr stats abc123 --json > stats.json\n```\n\n## Batch Create\n\nCreate a JSON file with an array of QR code definitions:\n\n```json\n[\n { \"content\": \"https://example.com/1\", \"mode\": \"DYNAMIC\", \"name\": \"Link 1\" },\n { \"content\": \"https://example.com/2\", \"mode\": \"DYNAMIC\", \"name\": \"Link 2\" }\n]\n```\n\nThen run:\n\n```bash\ncodebox qr batch items.json\n```\n\n## Custom Server\n\nFor self-hosted CodeBox instances:\n\n```bash\ncodebox config set base-url https://my-codebox.example.com\n# or\nexport CODEBOX_BASE_URL=https://my-codebox.example.com\n```\n","readmeFilename":"README.md","_rev":"1-788adbb602307562878b5c5cee0cc693"}