フェイシュ2MD

フェイシュ2MD

これは、Go 言語を使用して実装された、Feishu ドキュメントを Markdown ファイルとしてダウンロードするためのツールです。

こちらをご覧ください: ニーズと関心のある開発者を募集し、一緒に開発とメンテナンスについて話し合います。ご興味がございましたら、お問い合わせください。

モチベーション

「1 日 1 スキル | 私が開発したこの小さなツールは、Feishu ドキュメントを Markdown に簡単に変換するのに役立ちます。」

APIトークンの取得

設定ファイルには APP ID と APP SECRET 情報を入力する必要があります。Feishu の公式ドキュメントを参照して取得してください。推奨設定は

• Feishu 開発者バックエンドに入る
• 自作アプリ（個人版）を作成し、好きな情報を入力してください
• (重要) 権限管理を開き、次の必要な権限を有効にします (以下のリンクをクリックして、API デバッグ コンソール -> 権限設定フィールドを参照できます)
  • ドキュメントの基本情報を取得、「ドキュメントの新しいバージョンを表示」権限docx:document:readonly
  • ドキュメントのすべてのブロックを取得します。「ドキュメントの新しいバージョンを表示」権限docx:document:readonly
  • 資料のダウンロード、「クラウド ドキュメントの画像と添付ファイルのダウンロード」権限docs:document.media:download
  • フォルダー内のファイルリストを取得します。「クラウドスペース内のすべてのファイルの表示、コメント、編集、管理」権限drive:file:readonly
  • ナレッジスペースノード情報の取得、「ナレッジベースの表示」権限wiki:wiki:readonly
• 資格情報と基本情報を開いて、アプリ ID とアプリ シークレットを取得します。

使用方法

注: Feishu ドキュメントの古いバージョンのダウンロード ツールは今後メンテナンスされないことが決定されましたが、ブランチ v1_support は引き続き使用でき、対応するアーカイブは v1.4.0 です。

コマンドラインバージョン

Go言語のクロスプラットフォーム機能により、主要なプラットフォームの実行ファイルがコンパイルされてReleaseでダウンロードでき、対応するプラットフォームのfeishu2md実行ファイルをPATHパスに置くことができます。

ヘルプドキュメントを確認してください

$ feishu2md -h
NAME:
  feishu2md - Download feishu/larksuite document to markdown file

USAGE:
  feishu2md [global options] command [command options] [arguments...]

VERSION:
  v2-0e25fa5

COMMANDS:
  config        Read config file or set field(s) if provided
  download, dl  Download feishu/larksuite document to markdown file
  help, h       Shows a list of commands or help for one command

GLOBAL OPTIONS:
  --help, -h     show help (default: false)
  --version, -v  print the version (default: false)

$ feishu2md config -h
NAME:
   feishu2md config - Read config file or set field(s) if provided

USAGE:
   feishu2md config [command options] [arguments...]

OPTIONS:
   --appId value      Set app id for the OPEN API
   --appSecret value  Set app secret for the OPEN API
   --help, -h         show help (default: false)

$ feishu2md dl -h
NAME:
  feishu2md download - Download feishu/larksuite document to markdown file

USAGE:
  feishu2md download [command options] < url >

OPTIONS:
  --output value, -o value  Specify the output directory for the markdown files (default: " ./ " )
  --dump                    Dump json response of the OPEN API (default: false)
  --batch                   Download all documents under a folder (default: false)
  --wiki                    Download all documents within the wiki. (default: false)
  --help, -h                show help (default: false)

設定ファイルを生成する

ツールの構成ファイルはfeishu2md config --appId --appSecret コマンドを通じて生成できます。

feishu2md configコマンドを使用すると、構成ファイルのパスと構成が成功したかどうかを確認できます。

その他の構成オプションについては、構成ファイルの変更を手動で開いてください。

単一のドキュメントをマークダウンとしてダウンロードする

feishu2md dl から直接ダウンロードします。ドキュメントのリンクは、共有 > リンク共有をオンにする > インターネット上でリンクを取得した人が読むことができます > リンクをコピーすることで取得できます。

例：

$ feishu2md dl " https://domain.feishu.cn/docx/docxtoken "

フォルダー内のすべてのドキュメントを Markdown として一括ダウンロードする

この機能は現在、Docker バージョンをサポートしていません

feishu2md dl --batch から直接ダウンロードします。フォルダのリンクは、共有 > リンク共有をオンにする > インターネット上でリンクを取得した人が読むことができます > リンクをコピーすることで取得できます。

例：

$ feishu2md dl --batch -o output_directory " https://domain.feishu.cn/drive/folder/foldertoken "

ナレッジベースのすべてのドキュメントをマークダウンとしてバッチダウンロードします

feishu2md dl --wiki を通じて直接ダウンロードします。wiki 設定リンクは、ナレッジ ベースの設定を開くことで取得できます。

例：

$ feishu2md dl --wiki -o output_directory " https://domain.feishu.cn/wiki/settings/123456789101112 "

Docker のバージョン

Docker イメージ: https://hub.docker.com/r/wwwsine/feishu2md

Docker コマンド: docker run -it --rm -p 8080:8080 -e FEISHU_APP_ID= -e FEISHU_APP_SECRET= -e GIN_MODE=release wwwsine/feishu2md

Docker Compose:

 # docker-compose.yml
version : ' 3 '
services :
  feishu2md :
    image : wwwsine/feishu2md
    environment :
      FEISHU_APP_ID : 
      FEISHU_APP_SECRET : 
      GIN_MODE : release
    ports :
      - " 8080:8080 "

サービスを開始しますdocker compose up -d

次に、https://127.0.0.1:8080 にアクセスし、ドキュメントのリンクを貼り付けます。ドキュメントのリンクは、 [共有] > [リンクの共有を有効にする] > [リンクをコピー]で取得できます。

オンライン版

私は個人用のテスト API トークンを使用して、不安定なバージョンをレンダリング プラットフォームにデプロイしました。このバージョンでは、ドキュメントや画像はコンテナに保存されず、圧縮されたパッケージ ファイルが HTTP 経由でメモリから直接返されますが、レンダリング プラットフォームのログは返されます。一部の HTTP 情報をログに記録する場合があります。

現在のバージョンは、プライバシーを気にしないユーザー、またはプライバシーを設定するのが面倒なユーザーによる一時的な使用のみを目的としており、自分のトークン権限設定に問題があるかどうかをテストして比較するためにも使用できます。レンダー プラットフォームは無料クォータを使用し、メモリの高可用性は 512M しか保証されていないため、トラスト チェーンは完全にオープン ソース コードに依存しているため、ご自身の判断で使用してください。

https://feishu2md.onrender.com/ にアクセスし、ドキュメントのリンクを貼り付けます。ドキュメントのリンクは、[共有] > [リンク共有を有効にする] > [リンクをコピー]で取得できます。

ありがたい

• カイロック/ヒバリ
• chyroc/lark_docs_md