lark-event

Stream Feishu/Lark events via WebSocket and output NDJSON.

Updated Aug 17, 2024
One-click install
npx skills add https://github.com/LinoWhy/.dotfiles --skill lark-event-linowhy
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: lark-event
Source: https://github.com/LinoWhy/.dotfiles/tree/main/agents/.agents/skills/lark-event
Command: npx skills add https://github.com/LinoWhy/.dotfiles --skill lark-event-linowhy

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Stream Feishu/Lark events in real time via a WebSocket long connection to provide NDJSON outputs for downstream processing.

Core Features & Use Cases

  • Real-time event subscription via lark-cli event +subscribe, producing NDJSON.
  • Supports compact output, regex routing, and optional file output for downstream processing.
  • Includes prerequisites for authentication and permissions and convenient shortcuts.

Quick Start

Run the lark-cli event +subscribe to begin streaming Lark events to stdout in NDJSON format for immediate processing.

Frequently Asked Questions about lark-event

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I stream Feishu events in real time via a WebSocket connection?

To stream Feishu events in real time via a WebSocket connection, run the lark-cli event subscribe command, which outputs NDJSON data directly to stdout for immediate downstream processing.

What is NDJSON output used for in Lark bot event subscriptions?

NDJSON output in Lark bot event subscriptions provides compact, line-delimited JSON records that are easy to parse for event-driven pipelines, enabling efficient on-demand routing and optional file exports.

Do I need authentication to subscribe to real-time Lark events?

Yes, you need authentication and specific permissions to subscribe to real-time Lark events, as documented in the lark-shared SKILL.md, ensuring secure bot-based automation and event-driven pipelines.

Can I use regex routing to filter Feishu events in my automation pipeline?

Yes, you can use regex routing to filter Feishu events in your automation pipeline, allowing you to selectively process specific real-time WebSocket events and output them as NDJSON.

How do I export Lark event subscriptions to a file?

You can export Lark event subscriptions to a file by utilizing the optional file output feature during the lark-cli event subscribe workflow, capturing the real-time NDJSON stream for offline processing.