feishu-docx

Feishu-docx is an automation tool that reads, writes, and manages Feishu/Lark knowledge bases by converting documents, spreadsheets, Bitables, and wiki nodes to Markdown format. It supports OAuth 2.0 authentication, CLI and TUI interfaces, and integrates with Claude Skills for seamless AI agent access. The tool handles rich-text formatting, embedded tables, images, attachments, and weChat article imports while offering cloud-space file management capabilities. Operations teams benefit from automated knowledge base exports, batch wiki backups, and direct document creation workflows. Setup requires minimal configuration with automatic token refresh and supports both app-level and user-level permissions.

[{"step":"Authenticate with Feishu/Lark using OAuth 2.0. Run the command: `feishu-docx auth --client-id YOUR_CLIENT_ID --client-secret YOUR_CLIENT_SECRET` and follow the redirect URL to complete authentication.","tip":"Use the CLI tool for batch processing or the TUI for interactive selection of documents. For Claude Skills, ensure the OAuth token is stored in your environment variables."},{"step":"List available documents to identify the target [DOCUMENT_NAME] and [DOCUMENT_TYPE]. Run: `feishu-docx list --type doc` (replace 'doc' with 'sheet' or 'bitable' as needed).","tip":"Use filters like `--created-after 2023-10-01` to narrow down large document libraries."},{"step":"Convert the document to Markdown. For a single document: `feishu-docx convert --doc-id DOC123456 --output project-phoenix.md`. For batch conversion: `feishu-docx batch-convert --type sheet --output-dir ./markdown-exports/`","tip":"Add `--include-images` to embed images as base64 data URIs in the Markdown file."},{"step":"Verify the output file. Open [OUTPUT_FILENAME].md in a Markdown editor (e.g., VS Code, Typora) to check for formatting errors, broken tables, or missing images.","tip":"Use `feishu-docx validate --file project-phoenix.md` to automatically check for common conversion issues."},{"step":"Integrate with workflows. For example, pipe the output to a GitHub repository: `feishu-docx convert --doc-id DOC123456 --output - | gh gist create -f project-phoenix.md`","tip":"Schedule regular conversions using cron jobs or CI/CD pipelines (e.g., GitHub Actions) to keep Markdown exports up-to-date."}]