feishu-md-exporter

Usage

pnpm start --url "https://my.feishu.cn/docx/TEST_DOCX_TOKEN_001" \
  --app-id "<your-app-id>" \
  --app-secret "<your-app-secret>"

This command recursively discovers linked Feishu documents starting from --url, writes a manifest JSON to ./output/manifest.json, and exports markdown files into ./output.

Options

• --url <url>: root document url (required)
• --app-id <appId>: Feishu app id (required unless FEISHU_APP_ID is set)
• --app-secret <appSecret>: Feishu app secret (required unless FEISHU_APP_SECRET is set)
• --output <path>: output directory for manifest + markdown (default output)
• --manifest <name>: manifest file name under output directory (default manifest.json)
• --max-depth <n>: max recursive depth (default 10)
• --max-docs <n>: max discovered docs (default 1000)
• --page-size <n>: API page size (default 200, range 1-500)
• --debug: print detailed HTTP/debug logs to stderr

Configuration

Config file is supported via unconfig:

• feishu-md-exporter.config.ts

Example:

import { defineConfig } from 'feishu-md-exporter'

export default defineConfig({
  url: 'https://my.feishu.cn/docx/TEST_DOCX_TOKEN_001',
  maxDepth: 10,
  maxDocs: 1000,
  pageSize: 200,
})

Environment variables are also supported:

• FEISHU_APP_ID
• FEISHU_APP_SECRET
• FEISHU_PAGE_SIZE
• FEISHU_DEBUG

.env and .env.local in cwd are loaded automatically.

Where to find App ID / App Secret

1. Open 飞书开放平台
2. Go to your app in 开发者后台 (self-built app)
3. Open 凭证与基础信息 (or similarly named credentials page)
4. Copy App ID and App Secret

License

MIT License © jinghaihan