@nestbox-ai/cli 1.0.36 → 1.0.37
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/GETTING_STARTED.md +32 -24
- package/package.json +1 -1
package/GETTING_STARTED.md
CHANGED
|
@@ -56,20 +56,40 @@ nestbox compute status <compute-id>
|
|
|
56
56
|
|
|
57
57
|
Create a new agent project from templates:
|
|
58
58
|
```bash
|
|
59
|
-
nestbox generate project <folder-name>
|
|
59
|
+
nestbox generate project <folder> --lang <ts|js> --template <agent|chatbot> --name <agent-name>
|
|
60
60
|
```
|
|
61
61
|
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
-
|
|
65
|
-
|
|
66
|
-
|
|
62
|
+
Example - TypeScript agent:
|
|
63
|
+
```bash
|
|
64
|
+
nestbox generate project my-agent --lang ts --template agent --name myAgent
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
Example - JavaScript chatbot:
|
|
68
|
+
```bash
|
|
69
|
+
nestbox generate project my-chatbot --lang js --template chatbot --name myChatbot --project my-project-id
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
Available options:
|
|
73
|
+
- `--lang`: Choose `ts` (TypeScript) or `js` (JavaScript)
|
|
74
|
+
- `--template`: Choose `agent` or `chatbot`
|
|
75
|
+
- `--name`: Agent/Chatbot name (must be valid function name)
|
|
76
|
+
- `--project`: Optional project ID
|
|
67
77
|
|
|
68
78
|
### 5. Deploy Your Agent
|
|
69
79
|
|
|
70
80
|
From your agent directory:
|
|
71
81
|
```bash
|
|
72
|
-
nestbox agent deploy
|
|
82
|
+
nestbox agent deploy --agent <agent-name> --project <project-name>
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
Deploy with detailed logs:
|
|
86
|
+
```bash
|
|
87
|
+
nestbox agent deploy --agent <agent-name> --project <project-name> --log
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
Deploy a specific zip or directory:
|
|
91
|
+
```bash
|
|
92
|
+
nestbox agent deploy --agent <agent-name> --zip ./path/to/agent --project <project-name>
|
|
73
93
|
```
|
|
74
94
|
|
|
75
95
|
List deployed agents:
|
|
@@ -87,21 +107,21 @@ nestbox agent remove
|
|
|
87
107
|
### Development Cycle
|
|
88
108
|
```bash
|
|
89
109
|
# Generate agent project
|
|
90
|
-
nestbox generate project my-agent
|
|
110
|
+
nestbox generate project my-agent --lang ts --template agent --name myAgent
|
|
91
111
|
|
|
92
112
|
# Develop locally
|
|
93
113
|
cd my-agent
|
|
94
114
|
npm install
|
|
95
115
|
npm run dev
|
|
96
116
|
|
|
97
|
-
# Deploy
|
|
98
|
-
nestbox agent deploy --
|
|
117
|
+
# Deploy agent
|
|
118
|
+
nestbox agent deploy --agent my-agent --project my-project --log
|
|
99
119
|
|
|
100
120
|
# Test and validate
|
|
101
121
|
nestbox agent list
|
|
102
122
|
|
|
103
|
-
# Deploy
|
|
104
|
-
nestbox agent deploy --
|
|
123
|
+
# Deploy with specific instance
|
|
124
|
+
nestbox agent deploy --agent my-agent --instance production --log
|
|
105
125
|
```
|
|
106
126
|
|
|
107
127
|
### Managing Documents
|
|
@@ -116,18 +136,6 @@ nestbox document list
|
|
|
116
136
|
nestbox document delete <document-id>
|
|
117
137
|
```
|
|
118
138
|
|
|
119
|
-
### Managing Images
|
|
120
|
-
```bash
|
|
121
|
-
# Build and push custom images
|
|
122
|
-
nestbox image build
|
|
123
|
-
|
|
124
|
-
# List available images
|
|
125
|
-
nestbox image list
|
|
126
|
-
|
|
127
|
-
# Use custom image in agent
|
|
128
|
-
nestbox agent deploy --image <image-id>
|
|
129
|
-
```
|
|
130
|
-
|
|
131
139
|
## Configuration
|
|
132
140
|
|
|
133
141
|
The CLI stores configuration in `.nestboxrc` in your home directory. You can also use project-specific configuration by creating a `nestbox.config.json` file:
|