Caixuan CLI & SDK

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

Command-line tool and TypeScript SDK for the Caixuan platform. Use them from the terminal, scripts, or server-side to manage spaces, shares, documents, and members.

Requires Node.js >= 18.

CLI

Package: @caixuan-cc/cli. After installation, the caixuan command is available.

Installation

npm install -g @caixuan-cc/cli

Quick start

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

For more commands, authentication setup, and JSON output formats, see apps/node-cli/README.md.

Typical use cases (upload & share, password links, expiry, CI publish, and more): apps/node-cli/docs/use-cases.md.

SDK (TypeScript)

Package: @caixuan-cc/sdk. Call the Caixuan API from Node.js applications.

Installation

npm install @caixuan-cc/sdk

Quick start

import { createCaixuan } from '@caixuan-cc/sdk';

const client = createCaixuan({ token: process.env.CAIXUAN_TOKEN });

const { rows: spaces } = await client.spaces.list();
const file = await client.files.upload('./deck.pptx');
const doc = await client.docs.create({
  spaceId: spaces[0].id,
  fileId: file.id,
  name: file.name,
});

For full API reference, initialization options, error handling, and upload workflows, see sdks/typescript/README.md.

License

MIT