@coremail/lunkr-openclaw 1.0.0 → 1.0.2

package/README.md

@@ -27,144 +27,82 @@ This plugin enables OpenClaw AI agents to interact with Lunkr through:
 npm install @coremail/lunkr
 ```
 
-### Local Development
-
-```bash
-cd extensions/lunkr
-npm install
-npm run build
-```
-
-## Quick Reference
-
-| Command | Description |
-|---------|-------------|
-| `npm test` | Run tests |
-| `npm run build` | Compile TypeScript |
-| `npm run deploy:local` | Deploy to local OpenClaw |
-| `npm run pack` | Create release package |
-
-> See [DEVELOPMENT.md](./docs/DEVELOPMENT.md) for complete development guide.
-
 ## Quick Start
 
-### 1. Login to Lunkr
+### 1. Create a Bot Discussion (Optional)
 
-First, authenticate with your Lunkr account:
+Create a dedicated Bot discussion where all messages automatically trigger the AI:
 
 ```bash
-openclaw lunkr login --email your-email@example.com
+openclaw lunkr bot-create "My Bot"
 ```
 
-You will be prompted for your password. The session will be stored securely in `~/.lunkr-mcp/config.json`.
+### 2. Start Chatting
 
-### 2. Enable the Channel
+- **In Bot Discussions**: All messages automatically trigger the AI
+- **In normal groups/DMs**: Use `/bot <message>` to trigger the AI
 
-Add Lunkr to your OpenClaw configuration:
+## Bot Discussions
 
-```yaml
-channels:
-  lunkr:
-    enabled: true
-    botName: "AI Assistant"
-    commandPrefix: "/bot"
-```
+Bot Discussions are dedicated groups where all messages automatically trigger the AI agent without needing a command prefix.
 
-### 3. Restart the Gateway
+### Create a Bot Discussion
 
 ```bash
-openclaw gateway restart
-```
-
-### 4. Start Chatting
+# Basic creation
+openclaw lunkr bot-create "Help Desk"
 
-- **In Bot Discussions**: All messages automatically trigger the AI
-- **In normal groups/DMs**: Use `/bot <message>` to trigger the AI
+# Associate with a specific agent (multi-agent routing)
+openclaw lunkr bot-create "Sales Bot" --agent-id sales-agent
 
-## Configuration
+# Force create a new discussion (don't reuse existing)
+openclaw lunkr bot-create "My Bot" --force
+```
 
-### Basic Configuration
+**Notes:**
+- 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 `--force` to create a new discussion instead of reusing
 
-```yaml
-channels:
-  lunkr:
-    enabled: true
-    botName: "Bot"
-    commandPrefix: "/bot"
-    dmPolicy: "allow"
-    groupPolicy: "allow"
-```
+**Options:**
 
-### Configuration Options
-
-| Option | Type | Default | Description |
-|--------|------|---------|-------------|
-| `enabled` | boolean | `true` | Enable/disable the channel |
-| `botName` | string | `"Bot"` | Display name for bot replies |
-| `commandPrefix` | string | `"/bot"` | Prefix to trigger bot in normal chats |
-| `dmPolicy` | string | `"allow"` | DM access policy: `allow`, `deny`, `whitelist` |
-| `allowFrom` | string[] | `[]` | Whitelisted user IDs for DM (when `dmPolicy: whitelist`) |
-| `groupPolicy` | string | `"allow"` | Group access policy: `allow`, `deny`, `whitelist` |
-| `groups` | string[] | `[]` | Whitelisted group IDs (when `groupPolicy: whitelist`) |
-| `botDiscussions` | object | `{}` | Bot discussion configurations |
-
-### Bot Discussions
-
-Bot Discussions are dedicated groups where all messages trigger the AI agent without needing a prefix:
-
-```yaml
-channels:
-  lunkr:
-    botDiscussions:
-      "discussion-id-123":
-        name: "AI Help Desk"
-        agentId: "support-agent"
-        creatorUid: "user-456"
-        createdAt: "2024-01-15T10:30:00Z"
-```
+| 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 |
 
-### Multi-Agent Routing
-
-You can route different Bot Discussions to different AI agents:
-
-```yaml
-channels:
-  lunkr:
-    botDiscussions:
-      "sales-discussion":
-        name: "Sales Bot"
-        agentId: "sales-agent"
-        creatorUid: "admin"
-        createdAt: "2024-01-01T00:00:00Z"
-      "support-discussion":
-        name: "Support Bot"
-        agentId: "support-agent"
-        creatorUid: "admin"
-        createdAt: "2024-01-01T00:00:00Z"
-```
+### List Bot Discussions
 
-## Security
+```bash
+openclaw lunkr bot-list
 
-### DM Policies
+# Output as JSON
+openclaw lunkr bot-list --json
+```
 
-- **`allow`** (default): Accept DMs from all users
-- **`deny`**: Reject all DMs
-- **`whitelist`**: Only accept DMs from users in `allowFrom`
+### Delete a Bot Discussion
 
-### Group Policies
+```bash
+# Delete by name
+openclaw lunkr bot-delete "Help Desk"
 
-- **`allow`** (default): Respond in all groups when mentioned
-- **`deny`**: Never respond in groups
-- **`whitelist`**: Only respond in groups listed in `groups`
+# Delete by GID
+openclaw lunkr bot-delete --gid discussion-id-123
+```
 
-### Pairing
+> **Note:** Deleting removes the discussion from both Lunkr server and OpenClaw configuration.
 
-Users can pair with the bot to be added to the whitelist:
+## CLI Commands
 
-```bash
-# User sends a pairing code
-openclaw pairing approve lunkr <code>
-```
+| Command | Description |
+|---------|-------------|
+| `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 |
 
 ## Troubleshooting
 
@@ -186,8 +124,8 @@ openclaw pairing approve lunkr <code>
 If you see authentication errors:
 
 ```bash
-openclaw lunkr logout
-openclaw lunkr login --email your-email@example.com
+openclaw lunkr login
+openclaw gateway restart
 ```
 
 ### Connection Issues