feishu2md

feishu2md

Esta es una herramienta para descargar documentos Feishu como archivos Markdown, implementada utilizando el lenguaje Go.

Consulte aquí: Reclute desarrolladores con necesidades e intereses para discutir juntos el desarrollo y el mantenimiento. Si está interesado, contáctenos.

motivación

"Una habilidad al día | Esta pequeña herramienta que desarrollé puede ayudarte fácilmente a convertir documentos Feishu en Markdown"

Obtener token API

El archivo de configuración debe completar la ID de la APLICACIÓN y la información SECRETA de la APLICACIÓN. Consulte la documentación oficial de Feishu para obtenerla. La configuración recomendada es

• Ingrese al backend del desarrollador de Feishu
• Cree una aplicación de construcción propia (versión personal) y complete la información que desee
• (Importante) Abra la administración de permisos y habilite los siguientes permisos necesarios (puede hacer clic en el enlace a continuación para consultar la consola de depuración de API -> campo de configuración de permisos)
  • Obtener información básica del documento, permiso "Ver nueva versión del documento" docx:document:readonly
  • Obtenga todos los bloques del documento, permiso "Ver nueva versión del documento" docx:document:readonly
  • Descargar materiales, permiso "Descargar imágenes y archivos adjuntos en documentos en la nube" docs:document.media:download
  • Obtenga la lista de archivos en la carpeta, drive:file:readonly
  • Obtener información del nodo del espacio de conocimiento, permiso "Ver base de conocimiento" wiki:wiki:readonly
• Abra las credenciales y la información básica para obtener el ID de la aplicación y el secreto de la aplicación.

como usar

Nota: Se ha decidido que la herramienta de descarga para versiones antiguas de documentos Feishu ya no se mantendrá, pero la rama v1_support aún se puede usar y el archivo correspondiente es v1.4.0.

Versión de línea de comando

Con la función multiplataforma del lenguaje Go, los archivos ejecutables de las plataformas principales se han compilado y se pueden descargar en Release, y el archivo ejecutable feishu2md de la plataforma correspondiente se puede colocar en la ruta PATH.

Consulta la documentación de ayuda.

$ 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)

Generar archivo de configuración

El archivo de configuración de la herramienta se puede generar mediante el comando feishu2md config --appId --appSecret .

Puede utilizar el comando feishu2md config para comprobar la ruta del archivo de configuración y si la configuración se realizó correctamente.

Para obtener más opciones de configuración, abra manualmente los cambios del archivo de configuración.

Descargar un solo documento como Markdown

Descargue directamente a través de feishu2md dl , el enlace del documento se puede obtener compartiendo> active el uso compartido de enlaces> las personas que obtienen el enlace en Internet pueden leer> copiar el enlace .

Ejemplo:

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

Descargue por lotes todos los documentos en una carpeta como Markdown

Esta característica no es compatible actualmente con las versiones de Docker

Descargue directamente a través de feishu2md dl --batch . El enlace de la carpeta se puede obtener compartiendo > active el uso compartido de enlaces > las personas que obtienen el enlace en Internet pueden leerlo > copiar el enlace .

Ejemplo:

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

Descargue por lotes todos los documentos de una base de conocimientos como Markdown

Descargue directamente a través de feishu2md dl --wiki , el enlace de configuración de wiki se puede obtener abriendo la configuración de la base de conocimientos.

Ejemplo:

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

versión acoplable

Imagen de Docker: https://hub.docker.com/r/wwwsine/feishu2md

Comando de Docker: docker run -it --rm -p 8080:8080 -e FEISHU_APP_ID= -e FEISHU_APP_SECRET= -e GIN_MODE=release wwwsine/feishu2md

Composición de Docker:

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

Inicie el servicio docker compose up -d

Luego visite https://127.0.0.1:8080 y pegue el enlace del documento. El enlace del documento se puede obtener compartiendo > Habilitar enlace compartido > Copiar enlace .

Versión en línea

Utilicé mi token API de prueba personal para implementar una versión inestable en la plataforma Render. Esta versión no guardará ninguna documentación ni imágenes en el contenedor y devuelve directamente el archivo del paquete comprimido desde la memoria a través de HTTP, sino el registro de la plataforma Render. puede registrar cierta información HTTP.

La versión actual es solo para uso temporal por parte de usuarios que no se preocupan por la privacidad o que son demasiado vagos para configurarla. También se puede usar para probar y comparar si hay un problema con su propia configuración de permisos de Token. La plataforma Render utiliza una cuota gratuita y solo tiene 512 M de memoria. No se garantiza la alta disponibilidad. La cadena de confianza depende completamente del código fuente abierto, así que úselo a su propia discreción.

Visite https://feishu2md.onrender.com/ y pegue el enlace del documento. El enlace del documento se puede obtener compartiendo > Habilitar enlace compartido > Copiar enlace .

agradecido

• quiroco/alondra
• chyroc/lark_docs_md