Caixuan CLI

English · 中文 · Français · Español · Deutsch · Русский · 日本語 · 한국어

Command-line tool for the Caixuan platform. Manage spaces, shares, documents, and space members from the terminal or in automation scripts.

Requirements

npm install -g @caixuan-cc/cli

# Browser OAuth (requires Web /cli/auth page)
caixuan login

# Or set token manually
caixuan config set-token <token>
caixuan config show

Configuration is stored in ~/.caixuan/config.json.

Environment overrides:

caixuan login
caixuan space list
caixuan space select <space-id>
caixuan share list --json
caixuan doc create --file ./deck.pptx
caixuan member list

End-to-end examples (upload & share, password lock, expiry, paid access, invite members, CI publish, and more): docs/use-cases.md.

Group	Commands
Auth	`login`, `logout`
Config	`config show`, `config set-token`, `config set-space`, `config set-api-base`
Space	`space list`, `space current`, `space select`, `space get`
Share	`share list`, `share get`, `share create`, `share update`, `share delete`
Doc	`doc list`, `doc get`, `doc create`, `doc update`, `doc delete`
Member	`member list`, `member get`, `member create`, `member update`, `member delete`

Pass --json on any command for structured output:

{
  "ok": true,
  "data": { ... },
  "meta": { "count": 42 }
}