feishu-docx

Feishu Docx Exporter

Feishu/Lark のクラウドドキュメントを Markdown にエクスポートし、AI による分析、執筆、自動化に活用できます。

セットアップ（一度のみ）

pip install feishu-docx
feishu-docx config set --app-id YOUR_APP_ID --app-secret YOUR_APP_SECRET

トークンは自動更新されます。ユーザーによる操作は不要です。

オプション機能は追加機能として分割されているため、基本のインストールは軽量です。zsh などのシェルでは、追加機能を引用符で囲んでください。

オプション：ブラウザーベースのエクスポート

export-browser には Playwright と Chromium ランタイムが必要です。

pip install 'feishu-docx[browser]'
playwright install chromium

オプション：PDF エクスポート

PDF エクスポートには pdf 追加機能が必要です。

pip install 'feishu-docx[pdf]'

ドキュメントをエクスポートする

feishu-docx export "<FEISHU_URL>" -o ./output

エクスポートされた Markdown ファイルは、ドキュメントのタイトルをファイル名として保存されます。

ドキュメントが公開されている場合、または現在のブラウザーセッションでのみ読み取り可能な場合は、次の方法をお勧めします。

feishu-docx export-browser "<FEISHU_OR_LARK_URL>" -o ./output

または、既存の Playwright セッションを再利用します。

feishu-docx export-browser "<FEISHU_OR_LARK_URL>" --storage-state ./storage_state.json

対応ドキュメントタイプ

• docx：Feishu のクラウドドキュメント → 画像付き Markdown
• sheet：スプレッドシート → Markdown テーブル
• bitable：多次元テーブル → Markdown テーブル
• wiki：ナレッジベースのノード → 自動解決してエクスポート
• 公開ドキュメント／ブラウザーで読み取り可能なドキュメント：ローカル画像と添付ファイルを含む、ブラウザーベースのエクスポート

コマンドリファレンス

コマンド	説明
feishu-docx export <URL>	ドキュメントを Markdown にエクスポート
feishu-docx export <URL> --pdf	ドキュメントを Markdown と PDF にエクスポート
feishu-docx export-browser <URL>	実際のブラウザーセッションでローカルアセットとともにエクスポート
feishu-docx export-wechat <URL>	WeChat の記事を Markdown にエクスポート
feishu-docx create <TITLE>	新しいドキュメントを作成
feishu-docx create --url <URL>	WeChat の記事からドキュメントを作成
feishu-docx write <URL>	ドキュメントにコンテンツを追記
feishu-docx update <URL>	特定のブロックを更新
feishu-docx drive ls	アプリまたは個人のクラウドスペースのファイルを一覧表示
feishu-docx drive perm-show <TOKEN>	公開権限を表示
feishu-docx drive perm-members <TOKEN>	権限を持つメンバーを一覧表示
feishu-docx drive clear	2 回の確認を経てファイルを削除
feishu-docx export-wiki-space <URL>	Wiki スペース全体を一括エクスポート
feishu-docx export-workspace-schema <ID>	bitable データベースのスキーマをエクスポート
feishu-docx auth	OAuth 認証
feishu-docx config set	認証情報を設定
feishu-docx config show	現在の設定を表示
feishu-docx config clear	トークンキャッシュを消去
feishu-docx tui	対話型 TUI インターフェース

使用例

Wiki ページをエクスポートする

feishu-docx export "https://xxx.feishu.cn/wiki/ABC123" -o ./docs

カスタムファイル名でドキュメントをエクスポートする

feishu-docx export "https://xxx.feishu.cn/docx/XYZ789" -o ./docs -n meeting_notes

公開ドキュメントまたはブラウザーで読み取り可能なドキュメントを、実際のブラウザーセッションでエクスポートする

feishu-docx export-browser "https://xxx.larkoffice.com/wiki/ABC123" -o ./browser_docs

ドキュメントを PDF としてエクスポートする

feishu-docx export "https://xxx.feishu.cn/docx/XYZ789" --pdf

コンテンツを直接読み取る（AI エージェントに推奨）

# Output content to stdout instead of saving to file
feishu-docx export "https://xxx.feishu.cn/wiki/ABC123" --stdout
# or use short flag
feishu-docx export "https://xxx.feishu.cn/wiki/ABC123" -c

ブロック ID を付けてエクスポートする（後で更新する場合）

# Include block IDs as HTML comments in the Markdown output
feishu-docx export "https://xxx.feishu.cn/wiki/ABC123" --with-block-ids
# or use short flag
feishu-docx export "https://xxx.feishu.cn/wiki/ABC123" -b

Wiki スペース全体を一括エクスポートする

# Export all documents in a wiki space (auto-extract space_id from URL)
feishu-docx export-wiki-space "https://xxx.feishu.cn/wiki/ABC123" -o ./wiki_backup

# Specify depth limit
feishu-docx export-wiki-space "https://xxx.feishu.cn/wiki/ABC123" -o ./docs --max-depth 3

# Export with Block IDs for later updates
feishu-docx export-wiki-space "https://xxx.feishu.cn/wiki/ABC123" -o ./docs -b

データベースのスキーマをエクスポートする

# Export bitable/workspace database schema as Markdown
feishu-docx export-workspace-schema <workspace_id>

# Specify output file
feishu-docx export-workspace-schema <workspace_id> -o ./schema.md

ドキュメントを書き込む（CLI）

ドキュメントを作成する

# Create empty document
feishu-docx create "我的笔记"

# Create with Markdown content
feishu-docx create "会议记录" -c "# 会议纪要\n\n- 议题一\n- 议题二"

# Create from Markdown file
feishu-docx create "周报" -f ./weekly_report.md

# Create in specific folder
feishu-docx create "笔记" --folder fldcnXXXXXX

# Create from a WeChat article URL
feishu-docx create --url "https://mp.weixin.qq.com/s/xxxxx"

フォルダートークンの取得方法：

1. ブラウザーで対象のフォルダーを開きます
2. URL からトークンを抽出します：https://xxx.feishu.cn/drive/folder/fldcnXXXXXX
3. fldcnXXXXXX がフォルダートークンです

既存のドキュメントにコンテンツを追記する

# Append Markdown content
feishu-docx write "https://xxx.feishu.cn/docx/xxx" -c "## 新章节\n\n内容"

# Append from file
feishu-docx write "https://xxx.feishu.cn/docx/xxx" -f ./content.md

ドライブファイルを管理する

# List app cloud-space documents
feishu-docx drive ls --auth-mode tenant --type docx

# List personal cloud-space documents
feishu-docx drive ls --auth-mode oauth --type docx

# Show public permission
feishu-docx drive perm-show "https://xxx.feishu.cn/docx/ABC123"

# List permission members
feishu-docx drive perm-members "https://xxx.feishu.cn/docx/ABC123"

# Clear files with double confirmation
feishu-docx drive clear --type docx

特定のブロックを更新する

# Step 1: Export with Block IDs
feishu-docx export "https://xxx.feishu.cn/docx/xxx" -b -o ./

# Step 2: Find block ID from HTML comments
# 
# # Heading
# 

# Step 3: Update the specific block
feishu-docx update "https://xxx.feishu.cn/docx/xxx" -b blk123abc -c "新内容"

AI エージェント向けのヒント：特定のセクションを更新する場合：

1. -b を指定してエクスポートし、ブロック ID を取得します
2. HTML コメントから対象のブロック ID を見つけます
3. そのブロック ID を指定して feishu-docx update を実行します

ヒント

• ローカルアセットを利用できる場合、画像と添付ファイルは {doc_title}/ フォルダーに自動ダウンロードされます
• 公開共有リンクやブラウザーで読み取り可能なドキュメントには、export-browser をお勧めします
• コンテンツを直接出力するには、--stdout または -c を使用します（エージェントに推奨）
• 後で更新するためにブロック ID を付けてエクスポートするには、-b を使用します
• トークンは自動更新されるため、再認証は不要です
• Lark（海外版）の場合は、--lark フラグを追加します
• tenant_access_token はアプリのクラウドスペースを管理し、user_access_token は個人のクラウドスペースを管理します