Feishu File

What This Skill Does

The Feishu File Skill provides a powerful way to manage file interactions within the Feishu (Lark) platform directly from your command line or automated workflows. Leveraging the Feishu API, this skill enables seamless uploading of local files to Feishu chats or individual users, as well as downloading files received via Feishu messages. It's particularly useful for integrating Feishu's communication capabilities with your existing file management processes or for building automated systems that rely on file sharing.

To ensure proper authentication and authorization, this skill depends on the feishu-common package, which handles token management and API authentication. This dependency must be installed prior to using the Feishu File Skill.

The skill offers three primary commands:

1. Send File: This command allows you to upload a file from your local storage and send it directly to a specified chat or user within Feishu. This is ideal for sharing documents, images, or any other files as part of your Feishu conversations.
2. Upload Only: If you only need to upload a file without immediately sending it, this command is for you. It uploads the file to Feishu and returns a file_key. This file_key is a crucial identifier that can be used later when embedding the file within Feishu cards or rich text messages, offering flexibility in how you present shared content.
3. Download File: This command enables you to download files that have been shared in Feishu messages. You'll need the message-id and the file-key of the message containing the file. The downloaded file will be saved to a local path you specify. It's important to note that the bot executing this command must have access to the message, meaning it should be a member of the chat where the message was sent. For files shared by other users, the im:resource:read scope is also necessary for the bot's application.

Installation

To install the Feishu File Skill, use the following command:

clawhub install openclaw/skills/skills/autogame-17/feishu-file

Before installing this skill, ensure you have feishu-common installed: npm install feishu-common (or the equivalent command for your package manager).

Use Cases

• Automated Document Sharing: Upload and share reports, meeting minutes, or project updates with specific teams or individuals in Feishu automatically.
• Integration with CI/CD Pipelines: Send build artifacts or logs to a dedicated Feishu channel upon successful deployment.
• Content Management: Upload images or other media to Feishu and obtain their file_key for use in dynamic cards or rich text notifications.
• Archiving Feishu Files: Download important files shared in chats for local backup or further processing.
• Chatbot Enhancements: Augment your chatbots with the ability to share files received from users or external systems into Feishu.

Example Prompts

1. Upload and send my report.pdf to the #projects channel.
2. Get the file_key for image.jpg to use in a card.
3. Download the file from message with ID 'msg_abc123' and file key 'xyz789' to my local downloads folder.

Tips & Limitations

• Prerequisite: Always ensure feishu-common is installed and configured correctly. This skill relies on it for authentication.
• Permissions: For downloading files, ensure the bot has the necessary permissions (im:resource:read scope if reading messages from others) and is part of the relevant chat.
• File Keys: Remember that file_key is essential for both uploading files for later use in rich content and for downloading specific files from messages.
• Error Handling: Implement robust error handling in your scripts, as network issues or incorrect IDs can lead to failures. Check the output of each command for success or failure messages.
• Feishu API Limits: Be mindful of Feishu's API rate limits. Frequent, high-volume operations might require rate limiting on your end.
• Scope: The bot's application in Feishu must have the appropriate scopes enabled to perform these file operations.