@getrouter/getrouter-cli 0.1.0

package/.github/workflows/ci.yml

@@ -0,0 +1,19 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: oven-sh/setup-bun@v1
+        with:
+          bun-version: "1.3.5"
+      - run: bun install --frozen-lockfile
+      - run: bun run typecheck
+      - run: bun run test
+      - run: bun run build

package/AGENTS.md

@@ -0,0 +1,78 @@
+# Repository Guidelines
+
+## Project Structure & Module Organization
+
+- `src/` contains CLI source code (TypeScript). Commands live in `src/cmd/`, shared logic in `src/core/`, and generated dashboard clients in `src/generated/`.
+- `tests/` mirrors the source structure with Vitest test suites (e.g., `tests/cmd/`, `tests/core/`).
+- `docs/plans/` holds design and implementation plan documents for recent features.
+- Config and runtime files are written under `~/.getrouter` (or `GETROUTER_CONFIG_DIR`).
+
+## Build, Test, and Development Commands
+
+- `bun run dev -- --help`: run the CLI in dev mode via `tsx`.
+- `bun run build`: bundle the CLI to `dist/` with `tsdown`.
+- `bun run format`: format and lint code with Biome.
+- `bun run test`: run the full Vitest suite.
+- `bun run test -- tests/path/to/file.test.ts`: run a targeted test file.
+- `bun run typecheck`: run TypeScript type checks without emitting files.
+
+## Coding Style & Naming Conventions
+
+- TypeScript with 2-space indentation and double quotes, matching existing files.
+- File naming: kebab-case for docs, `*.test.ts` for tests, and `index.ts` for module entry points.
+- Prefer small helpers in `src/core/` and command wiring in `src/cmd/`.
+- Use Biome via `bun run format`; keep style consistent with nearby code.
+
+## Import Patterns & Module Organization
+
+- Use ES modules with `import type` for type-only imports.
+- Generated API clients imported from `src/generated/router/` with type-only imports.
+- Core utilities organized under `src/core/` with domain-specific folders (auth/, config/, http/, etc.).
+- Commands import helpers from `src/core/` and CLI utilities from `src/cli.ts`.
+
+## TypeScript Patterns
+
+- Strict typing enabled; define interfaces for all config and data structures.
+- Generic types for API responses (`ApiResponse<T>`) and HTTP handlers.
+- Union types for status codes and error types.
+- Prefer `interface` over `type` for object shapes unless you need union types.
+
+## Error Handling Patterns
+
+- Custom `ApiError` class with `createApiError(status, message)` helper.
+- Export structured error objects with `code`, `message`, and `requestId` fields.
+- HTTP methods should return data and throw `ApiError` for failures.
+- Use try/catch blocks in commands and exit gracefully with `process.exit(1)`.
+
+## CLI Development Patterns
+
+- Use Commander.js: `.command()`, `.description()`, `.option()`, `.action()`.
+- Commands are async functions that accept options object.
+- Use `consoleLog()` helper from `src/cli.ts` for consistent output.
+- Add emojis to command output for visual distinction.
+- Use `checkAuthenticated()` helper for commands requiring auth.
+
+## Testing Guidelines
+
+- Test framework: Vitest.
+- Test naming: `*.test.ts` under `tests/` with `describe/it` blocks.
+- Mock external dependencies with `vi.mock()` and `vi.hoisted()`.
+- Use temp directory helpers (`mkdtemp`, `rimraf`) for file system tests.
+- Test both success and error paths for commands.
+- Run targeted tests before full suite: `bun run test -- tests/path/to/file.test.ts`.
+- After modifying, always run `bun run test && bun run lint && bun run format`.
+
+## Configuration & Security
+
+- Config stored in `~/.getrouter/` or `GETROUTER_CONFIG_DIR`.
+- Auth tokens in `auth.json` with 0600 permissions.
+- Use `fsConfig` helper for config file operations.
+- Redact sensitive data in logs and CLI output.
+- Validate configuration with Zod schemas where applicable.
+
+## Commit & Pull Request Guidelines
+
+- Commit messages follow conventional prefixes: `feat:`, `fix:`, `docs:`, `test:`, `chore:`.
+- Keep commits scoped and focused (tests + implementation together when possible).
+- PRs should include a concise summary and test plan (commands run).
+- Screenshots are usually unnecessary for CLI changes.

package/README.ja.md

@@ -0,0 +1,116 @@
+# GetRouter CLI
+
+getrouter.dev 向けの CLI — API キーやサブスクリプションを管理し、vibecoding ツールを設定します。
+
+[English](README.md) | [简体中文](README.zh-cn.md) | 日本語
+
+## 要件
+
+- Node.js >= 18
+- Bun >= 1.3.5（開発用）
+
+## インストール
+
+npm で公開済みの場合:
+
+npm で
+
+```bash
+npm install -g @getrouter/getrouter-cli
+# or
+npx @getrouter/getrouter-cli --help
+```
+
+bun で
+
+```bash
+bun add -g @getrouter/getrouter-cli
+# or
+bunx @getrouter/getrouter-cli --help
+```
+
+ローカルビルド:
+
+```bash
+bun install
+bun run build
+```
+
+## クイックスタート
+
+- `getrouter login` — デバイスフローでログイン
+- `getrouter keys` — API キーを一覧表示（作成/更新/削除は対話式）
+- `getrouter codex` — Codex を設定（`~/.codex/config.toml` + `~/.codex/auth.json` を書き込み）
+
+## 認証
+
+デバイスフローでのログイン:
+
+```bash
+getrouter login
+```
+
+表示された URL をブラウザで開くと、CLI はトークンを受け取るまでポーリングします。
+
+## よく使うコマンド
+
+- `getrouter login` — デバイスフローでログイン
+- `getrouter logout` — ローカルのトークンを削除
+- `getrouter status` — ログイン + サブスクリプション状態を表示
+- `getrouter keys` — API キーの一覧/作成/更新/削除
+- `getrouter usages` — 直近 7 日間の使用量（チャート + テーブル）
+- `getrouter codex` — Codex を設定（config.toml + auth.json）
+- `getrouter claude --install` — Anthropic 互換の環境変数をインストール
+- `getrouter config` — CLI 設定を表示
+- `getrouter config apiBase https://getrouter.dev` — API Base URL を設定
+
+メモ:
+
+- `getrouter keys` はデフォルトで一覧表示し、作成/更新/削除は対話式です。
+- `getrouter status` はトークンを表示せずに認証/サブスクリプション情報を要約します。
+
+## 環境変数の設定
+
+`getrouter codex` は Codex の設定ファイルを書き込みます（シェルの環境変数は変更しません）。
+
+```bash
+getrouter codex
+```
+
+書き込まれるファイル（codex）:
+
+- `~/.codex/config.toml`（model + reasoning + provider 設定）
+- `~/.codex/auth.json`（OPENAI_API_KEY）
+
+`getrouter claude` は Anthropic 互換の環境変数を `~/.getrouter/env.sh`（または `env.ps1`）へ書き込みます。
+
+```bash
+getrouter claude --install
+```
+
+オプション（claude のみ）:
+
+- `--install`: `source ~/.getrouter/env.sh` をシェル rc に追記し、`claude` の自動 source hook をインストールして即時読み込みを試みます。初回はシェルの再読み込み（または `source ~/.zshrc`）が必要です。
+
+書き込まれる変数（claude）:
+
+```
+ANTHROPIC_BASE_URL=https://api.getrouter.dev/claude
+ANTHROPIC_API_KEY=<consumer api key>
+```
+
+## 設定とファイル
+
+デフォルトの設定ディレクトリ: `~/.getrouter`（`GETROUTER_CONFIG_DIR` で上書き）
+
+- `config.json`: CLI 設定
+- `auth.json`: アクセス/リフレッシュトークン
+- `env.sh` / `env.ps1`: 環境変数
+
+## 開発
+
+- `bun install` — 依存関係をインストール
+- `bun run dev -- --help` — ローカルで CLI を実行してヘルプ表示
+- `bun run format` — Biome でフォーマットと lint
+- `bun run test` — テスト実行
+- `bun run typecheck` — TypeScript 型チェック

package/README.md

@@ -0,0 +1,116 @@
+# GetRouter CLI
+
+CLI for getrouter.dev — manage API keys, subscriptions, and configure vibecoding tools.
+
+English | [简体中文](README.zh-cn.md) | [日本語](README.ja.md)
+
+## Requirements
+
+- Node.js >= 18
+- Bun >= 1.3.5 (for development)
+
+## Install
+
+If published to npm:
+
+With npm
+
+```bash
+npm install -g @getrouter/getrouter-cli
+# or
+npx @getrouter/getrouter-cli --help
+```
+
+With bun
+
+```bash
+bun add -g @getrouter/getrouter-cli
+# or
+bunx @getrouter/getrouter-cli --help
+```
+
+Local build:
+
+```bash
+bun install
+bun run build
+```
+
+## Quick Start
+
+- `getrouter login` — sign in via device flow
+- `getrouter keys` — list API keys (create/update/delete are interactive)
+- `getrouter codex` — configure Codex (writes `~/.codex/config.toml` + `~/.codex/auth.json`)
+
+## Auth
+
+Device-style login:
+
+```bash
+getrouter login
+```
+
+Follow the printed URL in your browser, then the CLI will poll until it receives tokens.
+
+## Common Commands
+
+- `getrouter login` — log in via device flow
+- `getrouter logout` — clear local tokens
+- `getrouter status` — show login + subscription status
+- `getrouter keys` — list/create/update/delete API keys
+- `getrouter usages` — show the last 7 days of usage (chart + table)
+- `getrouter codex` — configure Codex (config.toml + auth.json)
+- `getrouter claude --install` — install Anthropic-compatible env vars
+- `getrouter config` — show current CLI config
+- `getrouter config apiBase https://getrouter.dev` — set API base URL
+
+Notes:
+
+- `getrouter keys` lists keys by default; create/update/delete prompt for input.
+- `getrouter status` summarizes auth and subscription without printing tokens.
+
+## Environment Setup
+
+`getrouter codex` writes Codex configuration files (no shell env changes).
+
+```bash
+getrouter codex
+```
+
+Files written (codex):
+
+- `~/.codex/config.toml` (model + reasoning + provider settings)
+- `~/.codex/auth.json` (OPENAI_API_KEY)
+
+`getrouter claude` writes Anthropic-compatible env vars to `~/.getrouter/env.sh` (or `env.ps1`).
+
+```bash
+getrouter claude --install
+```
+
+Option (claude only):
+
+- `--install`: append `source ~/.getrouter/env.sh` to your shell rc, install an auto-source hook for `claude`, and try to load it immediately. Reload your shell (or `source ~/.zshrc`) once to activate the hook.
+
+Variables written (claude):
+
+```
+ANTHROPIC_BASE_URL=https://api.getrouter.dev/claude
+ANTHROPIC_API_KEY=<consumer api key>
+```
+
+## Config & Files
+
+Default config dir: `~/.getrouter` (override with `GETROUTER_CONFIG_DIR`)
+
+- `config.json`: CLI config
+- `auth.json`: access/refresh tokens
+- `env.sh` / `env.ps1`: environment variables
+
+## Development
+
+- `bun install` — install dependencies
+- `bun run dev -- --help` — run the local CLI and show help
+- `bun run format` — format and lint code with Biome
+- `bun run test` — run the test suite
+- `bun run typecheck` — run TypeScript type checks

package/README.zh-cn.md

@@ -0,0 +1,116 @@
+# GetRouter CLI
+
+getrouter.dev 的 CLI —— 用于管理 API key、订阅，并配置 vibecoding 工具。
+
+[English](README.md) | 简体中文 | [日本語](README.ja.md)
+
+## 依赖
+
+- Node.js >= 18
+- Bun >= 1.3.5（开发）
+
+## 安装
+
+若已发布到 npm：
+
+使用 npm
+
+```bash
+npm install -g @getrouter/getrouter-cli
+# 或
+npx @getrouter/getrouter-cli --help
+```
+
+使用 bun
+
+```bash
+bun add -g @getrouter/getrouter-cli
+# 或
+bunx @getrouter/getrouter-cli --help
+```
+
+本地构建：
+
+```bash
+bun install
+bun run build
+```
+
+## 快速开始
+
+- `getrouter login` — 登录并完成设备码授权
+- `getrouter keys` — 列出 API key（创建/更新/删除为交互式）
+- `getrouter codex` — 配置 Codex（写入 `~/.codex/config.toml` + `~/.codex/auth.json`）
+
+## 登录
+
+设备码式登录：
+
+```bash
+getrouter login
+```
+
+按提示打开浏览器完成确认，CLI 会轮询直到拿到 token。
+
+## 常用命令
+
+- `getrouter login` — 设备码登录
+- `getrouter logout` — 退出并清除本地 token
+- `getrouter status` — 查看登录与订阅状态
+- `getrouter keys` — 列出/创建/更新/删除 API key
+- `getrouter usages` — 查看最近 7 天使用量（图表 + 表格）
+- `getrouter codex` — 配置 Codex（config.toml + auth.json）
+- `getrouter claude --install` — 安装 Anthropic 兼容环境变量
+- `getrouter config` — 查看 CLI 配置
+- `getrouter config apiBase https://getrouter.dev` — 设置 API Base URL
+
+说明：
+
+- `getrouter keys` 默认列出，创建/更新/删除会交互提问。
+- `getrouter status` 会汇总登录与订阅信息，但不会展示 token。
+
+## 环境配置
+
+`getrouter codex` 写入 Codex 配置文件（不修改 shell 环境变量）。
+
+```bash
+getrouter codex
+```
+
+写入文件（codex）：
+
+- `~/.codex/config.toml`（model + reasoning + provider 设置）
+- `~/.codex/auth.json`（OPENAI_API_KEY）
+
+`getrouter claude` 写入 Anthropic 兼容环境变量到 `~/.getrouter/env.sh`（或 `env.ps1`）。
+
+```bash
+getrouter claude --install
+```
+
+可选参数（仅 claude）：
+
+- `--install`：写入 shell rc（追加 `source ~/.getrouter/env.sh`），安装 `claude` 自动 source 的 hook，并尝试立即生效；首次需要重新加载 shell（或 `source ~/.zshrc`）
+
+写入变量（claude）：
+
+```
+ANTHROPIC_BASE_URL=https://api.getrouter.dev/claude
+ANTHROPIC_API_KEY=<consumer api key>
+```
+
+## 配置与文件
+
+默认目录：`~/.getrouter`（可用 `GETROUTER_CONFIG_DIR` 覆盖）
+
+- `config.json`：CLI 配置
+- `auth.json`：token
+- `env.sh` / `env.ps1`：环境变量
+
+## 开发
+
+- `bun install` — 安装依赖
+- `bun run dev -- --help` — 本地运行 CLI 并查看帮助
+- `bun run format` — 使用 Biome 格式化并检查代码
+- `bun run test` — 运行测试
+- `bun run typecheck` — 运行 TypeScript 类型检查

package/biome.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "https://biomejs.dev/schemas/2.3.10/schema.json",
+  "files": {
+    "includes": ["**/*", "!dist", "!node_modules", "!src/generated"]
+  },
+  "formatter": {
+    "indentStyle": "space",
+    "indentWidth": 2
+  }
+}