@coremail/lunkr-openclaw
v1.2.0
Published
OpenClaw Lunkr/Coremail channel plugin
Readme
OpenClaw Lunkr Channel Plugin
A channel plugin for OpenClaw that provides integration with Lunkr, an enterprise collaboration platform from Coremail.
Overview
This plugin enables OpenClaw AI agents to interact with Lunkr through:
- Direct Messages (DM) - Private conversations between users
- Group Discussions - Team collaboration channels
- Bot Discussions - Dedicated groups where all messages trigger the AI agent
- Agent Accounts - Independent Lunkr accounts that respond to @mentions and DMs like real users
Requirements
- Node.js: v22 or higher
- OpenClaw: v2026.3 or higher
- Lunkr Account: A valid Lunkr/Coremail account with API access
Installation
Via npm (Recommended)
npm install @coremail/lunkrQuick Start
1. Run Setup
After installing the plugin, run setup to register plugin, tools, skills, and login:
openclaw lunkr setup2. Create a Bot Discussion (Optional)
Create a dedicated Bot discussion where all messages automatically trigger the AI:
openclaw lunkr bot-create "My Bot"3. Start Chatting
- In Bot Discussions: All messages automatically trigger the AI
- In normal groups/DMs: Use
/bot <message>to trigger the AI - With Agent Accounts: @mention the agent or send a DM (see Agent Accounts)
Bot Discussions
Bot Discussions are dedicated groups where all messages automatically trigger the AI agent without needing a command prefix.
Create a Bot Discussion
# Basic creation
openclaw lunkr bot-create "Help Desk"
# Associate with a specific agent (multi-agent routing)
openclaw lunkr bot-create "Sales Bot" --agent-id sales-agent
# Force create a new discussion (don't reuse existing)
openclaw lunkr bot-create "My Bot" --forceNotes:
- Discussion name is automatically formatted as
[Bot-<name>], e.g.,Help Desk→[Bot-Help Desk] - If a discussion with the same name already exists, it will be reused automatically
- Use
--forceto create a new discussion instead of reusing
Options:
| Option | Description |
|--------|-------------|
| -a, --agent-id <id> | Agent ID to associate (for multi-agent routing) |
| -f, --force | Force create new discussion, don't reuse existing |
| --no-welcome | Skip sending welcome message |
List Bot Discussions
openclaw lunkr bot-list
# Output as JSON
openclaw lunkr bot-list --jsonDelete a Bot Discussion
# Delete by name
openclaw lunkr bot-delete "Help Desk"
# Delete by GID
openclaw lunkr bot-delete --gid discussion-id-123Note: Deleting removes the discussion from both Lunkr server and OpenClaw configuration.
Agent Accounts
Agent accounts are independent Lunkr accounts that respond to @mentions and DMs — they look and behave like real users. Each agent account has its own WebSocket connection and is bound to an agentId for routing.
Add an Agent Account
# Login via QR code and bind to an agent
openclaw lunkr agent-add --agent-id my-agent
# Login via password
openclaw lunkr agent-add --bypwd -e [email protected] --agent-id my-agentManage Agent Accounts
# List all agent accounts
openclaw lunkr agent-list
# Remove an agent account
openclaw lunkr agent-remove [email protected]
# Change the bound agent ID
openclaw lunkr agent-bind [email protected] --agent-id new-agentDual Role (Standard + Agent)
The standard account can also act as an agent — it will respond to both /bot commands and @mentions:
openclaw lunkr agent-bind --self --agent-id my-agentSee docs/CONCEPTS.md for a detailed comparison of account types and trigger rules.
CLI Commands
All commands support -v, --verbose on the parent command for verbose output (e.g., openclaw lunkr -v login).
| Command | Description |
|---------|-------------|
| openclaw lunkr setup | One-click setup: register plugin, tools, skills, and login |
| openclaw lunkr rename <name> | Rename the bot (stored in ~/.lunkr/config.json) |
| openclaw lunkr login | Login via QR code (when session expires) |
| openclaw lunkr login-bypwd | Login via email/password (OTP supported) |
| openclaw lunkr skill-install [name] | Enable skill (default: lunkr) |
| openclaw lunkr skill-uninstall [name] | Disable skill |
| openclaw lunkr tool-install [name] | Add tool to tools.alsoAllow |
| openclaw lunkr tool-uninstall [name] | Remove tool from tools.alsoAllow |
| openclaw lunkr uninstall-extension | Remove all config added by setup |
| openclaw lunkr uninstall-extension --purge | Remove config + delete session data (~/.lunkr/) |
| openclaw lunkr agent-add | Add an agent account (independent login) |
| openclaw lunkr agent-list | List all agent accounts and their status |
| openclaw lunkr agent-remove <email> | Remove an agent account |
| openclaw lunkr agent-bind [email] | Bind/unbind an agent ID to an account |
Uninstall
Remove Configuration Only
Remove all OpenClaw config entries added by setup (plugin, tools, skills, channel):
openclaw lunkr uninstall-extensionFull Uninstall
Remove config and purge session data (~/.lunkr/):
openclaw lunkr uninstall-extension --purgeThen remove the extension files:
openclaw plugins uninstall lunkr-openclawTroubleshooting
Login Fails
- Verify your email and password are correct
- Check if your Lunkr server is accessible
- Ensure your account has API access enabled
Bot Not Responding
- Check the gateway logs:
openclaw gateway logs - Verify the channel is enabled in configuration
- Ensure you're using the correct command prefix (
/botby default) - For DMs, verify the
dmPolicyallows messages from your user
Session Expired
If you see authentication errors:
openclaw lunkr login
openclaw gateway restartConnection Issues
- Check your network connectivity
- Verify the Lunkr server URL is correct
- Check if there's a firewall blocking WebSocket connections
Capabilities
| Feature | Supported | |---------|-----------| | Direct Messages | Yes | | Group Messages | Yes | | Message Editing | Yes | | Message Replies | Yes | | Message Reactions | Yes | | Media Attachments | Yes | | Streaming Responses | Yes (blocked) | | Polls | No | | Threads | No | | Group Management | No |
License
MIT License - See LICENSE for details.
Support
- Issues: GitHub Issues
- Documentation: OpenClaw Docs
