ckweb-cli 0.2.0

package/README.md

@@ -0,0 +1,193 @@
+# ckweb-cli
+
+CLI tool for interacting with the [ClaudeKit.cc](https://claudekit.cc) API.
+
+## Install
+
+```bash
+pnpm install
+pnpm build
+pnpm link --global
+```
+
+## Quick Start
+
+```bash
+# Authenticate with your user API key
+ckweb auth login
+
+# Authenticate with admin API key
+ckweb auth login --admin
+
+# Check API health
+ckweb health
+
+# YouTube tools
+ckweb youtube info "https://youtube.com/watch?v=..."
+ckweb yt search "typescript tutorial"
+
+# Website analysis
+ckweb web review "https://example.com"
+ckweb web convert "https://example.com"
+
+# SEO insights
+ckweb seo keywords "react framework"
+ckweb seo traffic "example.com"
+```
+
+## Commands
+
+### Authentication
+| Command | Description |
+|---------|-------------|
+| `auth login [--admin]` | Authenticate with API key |
+| `auth validate [--admin]` | Validate stored key |
+| `auth logout [--admin\|--all]` | Remove stored key(s) |
+| `auth status` | Show authentication status |
+
+### Orders & Payments
+| Command | Description |
+|---------|-------------|
+| `orders get <id>` | Get order details |
+| `orders status <id>` | Check order status |
+| `checkout polar` | Create Polar checkout (USD) |
+| `checkout sepay` | Create SePay checkout (VND) |
+| `refunds request <orderId>` | Request a refund |
+
+### Account
+| Command | Description |
+|---------|-------------|
+| `account export-data` | Export your data (GDPR) |
+| `account delete` | Delete your account (GDPR) |
+| `account update-github <userId>` | Update GitHub username |
+
+### Referrals & Payouts
+| Command | Description |
+|---------|-------------|
+| `referrals dashboard` | View referral stats |
+| `referrals request-payout` | Request payout |
+| `referrals payout-history` | View payout history |
+| `payout profile` | View payout profiles |
+| `payout create-profile` | Create payout profile |
+| `payout delete-profile` | Delete payout profile |
+
+### Content
+| Command | Description |
+|---------|-------------|
+| `blog list` | List blog articles |
+| `blog get <id>` | Get article details |
+| `releases list [--tab]` | List product releases |
+
+### Proxy Services (YouTube, Web, SEO)
+| Command | Description |
+|---------|-------------|
+| `youtube info\|caption\|summary\|screenshot\|search\|comments` | YouTube tools |
+| `web review\|scrape\|extract\|convert\|summarize\|screenshot` | Website tools |
+| `seo keywords\|difficulty\|traffic\|backlinks` | SEO tools |
+
+### Pricing & Info
+| Command | Description |
+|---------|-------------|
+| `pricing validate-discount <code>` | Validate discount code |
+| `pricing exchange-rate` | Get USD/VND rate |
+| `pricing early-access` | Early access status |
+| `loyalty eligibility` | Check loyalty eligibility |
+| `stats users` | Platform user count |
+
+### Other
+| Command | Description |
+|---------|-------------|
+| `github invite\|revoke` | GitHub repo access |
+| `newsletter subscribe\|unsubscribe` | Newsletter management |
+| `waitlist join` | Join product waitlist |
+| `health` | Check API health |
+
+### Admin Commands (requires `ck_admin_*` key)
+| Group | Commands |
+|-------|----------|
+| `admin orders` | list, get, complete, refund, refund-keep-access, switch-product, resend-emails, export |
+| `admin users` | get, update-github, update-rates, set-tier, export |
+| `admin referrals` | stats, diagnose, export, tiers-stats |
+| `admin revenue` | stats, export, maintainer, costs, add-cost, update-cost, delete-cost, reports |
+| `admin payouts` | list, update, export, export-detailed, request-csv |
+| `admin loyalty` | stats, blast-email |
+| `admin blog` | create, update, delete, publish, ai-generate, ai-transform, generate-metadata, upload-url, export |
+| `admin keys` | list, create, validate, revoke, rotate |
+| `admin invites` | list, create, get, delete, resend, accept, validate |
+| `admin admins` | list, get, promote, demote, permissions |
+| `admin discounts` | list, create, update, delete, export |
+| `admin tiers` | list |
+
+## Authentication
+
+Two types of API keys:
+- **User key** (`ck_live_*`): For user-facing operations
+- **Admin key** (`ck_admin_*`): For admin operations
+
+```bash
+ckweb auth login          # User key
+ckweb auth login --admin  # Admin key
+ckweb auth status         # Show stored keys
+```
+
+Config stored at `~/.config/ckweb-cli/config.json`.
+
+### Env var resolution (priority)
+
+Keys and base URL resolve in this order (first match wins):
+
+1. **OS-level env** — `export CKWEB_API_KEY=…` / `CKWEB_ADMIN_API_KEY=…` / `CKWEB_API_URL=…`
+2. **Stored config** — values saved by `ckweb auth login` (or `login --admin`)
+3. **.env.*** — `.env.local` → `.env` in current working directory
+
+Env vars must match key format (`ck_live_…` / `ck_admin_…`) or they are skipped.
+
+## Output Modes
+
+All commands support:
+- `--json` — Raw JSON output (for piping/scripting)
+- `--table` — Formatted table (default for lists)
+- `--quiet` — Minimal output
+
+## Development
+
+```bash
+pnpm install
+pnpm dev        # Watch mode
+pnpm build      # Production build
+pnpm lint       # Type check
+pnpm test       # Run tests
+```
+
+## Releasing
+
+### Auto bump (recommended)
+
+Trigger the **Bump Version** workflow from the GitHub Actions tab:
+- `auto` — detects type from conventional commits since last tag
+  (`feat:` → minor, `fix:`/`perf:` → patch, `BREAKING CHANGE`/`!:` → major)
+- `patch` / `minor` / `major` — manual override
+
+Pushing the new tag triggers the **Release** workflow automatically.
+
+### Manual bump
+
+```bash
+npm version patch   # or minor / major
+git push --follow-tags
+```
+
+### Release workflow
+
+`.github/workflows/release.yml` (triggered by `v*` tag):
+1. Verifies tag matches `package.json` version
+2. Runs `lint` + `test` + `build`
+3. Publishes to npm with provenance (requires `NPM_TOKEN` secret)
+4. Creates GitHub Release with auto-generated notes
+
+## Tech Stack
+
+- TypeScript, Node.js 18+
+- Commander.js (CLI framework)
+- Conf (config storage)
+- tsup (bundler)