plazbot-cli 0.1.2 → 0.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +102 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
# Plazbot CLI
|
|
2
|
+
|
|
3
|
+
Official Command Line Interface for Plazbot - Manage your AI agents and portals directly from the terminal.
|
|
4
|
+
|
|
5
|
+
## Features
|
|
6
|
+
|
|
7
|
+
🤖 **Agent Management**
|
|
8
|
+
```bash
|
|
9
|
+
# Create a new agent
|
|
10
|
+
plazbot agent create -n "My Agent" -d "Description"
|
|
11
|
+
|
|
12
|
+
# List all agents
|
|
13
|
+
plazbot agent list
|
|
14
|
+
|
|
15
|
+
# Delete an agent
|
|
16
|
+
plazbot agent delete -i agent_id
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
🌐 **Portal Management**
|
|
20
|
+
```bash
|
|
21
|
+
# Add a link to portal
|
|
22
|
+
plazbot portal add-link -n "Example" -u "https://example.com"
|
|
23
|
+
|
|
24
|
+
# Clear all links
|
|
25
|
+
plazbot portal clear-links
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
💬 **WhatsApp Integration**
|
|
29
|
+
```bash
|
|
30
|
+
# Send a message
|
|
31
|
+
plazbot whatsapp send-message -t "+1234567890" -m "Hello"
|
|
32
|
+
|
|
33
|
+
# Send a template
|
|
34
|
+
plazbot whatsapp send-template -t "+1234567890" -n "welcome"
|
|
35
|
+
|
|
36
|
+
# Manage webhooks
|
|
37
|
+
plazbot whatsapp register-webhook -u "https://your-webhook.com"
|
|
38
|
+
plazbot whatsapp delete-webhook
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## Installation
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
npm install -g plazbot-cli
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
## Usage
|
|
48
|
+
|
|
49
|
+
### Portal Commands
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
# Add a link to portal
|
|
53
|
+
plazbot portal add-link -n "Example Link" -u "https://example.com"
|
|
54
|
+
|
|
55
|
+
# Clear all links
|
|
56
|
+
plazbot portal clear-links
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
### WhatsApp Commands
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
# Send a direct message
|
|
63
|
+
plazbot whatsapp send-message -t "+1234567890" -m "Hello World"
|
|
64
|
+
|
|
65
|
+
# Send a template message
|
|
66
|
+
plazbot whatsapp send-template -t "+1234567890" -n "welcome_template"
|
|
67
|
+
|
|
68
|
+
# Register a webhook
|
|
69
|
+
plazbot whatsapp register-webhook -u "https://your-webhook.com"
|
|
70
|
+
|
|
71
|
+
# Delete a webhook
|
|
72
|
+
plazbot whatsapp delete-webhook
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
## Command Options
|
|
76
|
+
|
|
77
|
+
### Portal Commands
|
|
78
|
+
- `add-link`
|
|
79
|
+
- `-n, --name`: Link name
|
|
80
|
+
- `-u, --url`: Link URL
|
|
81
|
+
- `clear-links`: No options required
|
|
82
|
+
|
|
83
|
+
### WhatsApp Commands
|
|
84
|
+
- `send-message`
|
|
85
|
+
- `-t, --to`: Recipient phone number
|
|
86
|
+
- `-m, --message`: Message text
|
|
87
|
+
- `send-template`
|
|
88
|
+
- `-t, --to`: Recipient phone number
|
|
89
|
+
- `-n, --name`: Template name
|
|
90
|
+
- `register-webhook`
|
|
91
|
+
- `-u, --url`: Webhook URL
|
|
92
|
+
- `delete-webhook`: No options required
|
|
93
|
+
|
|
94
|
+
## Requirements
|
|
95
|
+
|
|
96
|
+
- Node.js 14 or higher
|
|
97
|
+
- npm or yarn package manager
|
|
98
|
+
- Valid Plazbot API credentials
|
|
99
|
+
|
|
100
|
+
## Support
|
|
101
|
+
|
|
102
|
+
For issues and feature requests, please visit our [GitHub repository](https://github.com/plazbot/plazbot-cli) or contact support@plazbot.com
|