@nestbox-ai/cli 1.0.35 → 1.0.36
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 +158 -0
- package/package.json +1 -1
|
@@ -0,0 +1,158 @@
|
|
|
1
|
+
# Getting Started with Nestbox CLI
|
|
2
|
+
|
|
3
|
+
Welcome to the Nestbox CLI! This guide will get you up and running with building, managing, and deploying AI agents on the Nestbox platform.
|
|
4
|
+
|
|
5
|
+
## Prerequisites
|
|
6
|
+
|
|
7
|
+
- Node.js 18+ installed
|
|
8
|
+
- A Nestbox platform account
|
|
9
|
+
|
|
10
|
+
## Installation
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
npm install -g @nestbox-ai/cli
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Quick Start
|
|
17
|
+
|
|
18
|
+
### 1. Login to Nestbox
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
nestbox login demo.nestbox.com
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
This opens your browser for Google SSO authentication. Once authenticated, your credentials are stored locally.
|
|
25
|
+
|
|
26
|
+
### 2. Manage Projects
|
|
27
|
+
|
|
28
|
+
List your projects:
|
|
29
|
+
```bash
|
|
30
|
+
nestbox project list
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Switch to a project:
|
|
34
|
+
```bash
|
|
35
|
+
nestbox project use <project-name>
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
Add a new project:
|
|
39
|
+
```bash
|
|
40
|
+
nestbox project add <project-name> [alias]
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
### 3. Check Available Compute
|
|
44
|
+
|
|
45
|
+
List available compute resources:
|
|
46
|
+
```bash
|
|
47
|
+
nestbox compute list
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
Check compute status:
|
|
51
|
+
```bash
|
|
52
|
+
nestbox compute status <compute-id>
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
### 4. Generate Agent Projects
|
|
56
|
+
|
|
57
|
+
Create a new agent project from templates:
|
|
58
|
+
```bash
|
|
59
|
+
nestbox generate project <folder-name>
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
Available templates:
|
|
63
|
+
- `base-js` - Basic JavaScript agent
|
|
64
|
+
- `base-ts` - Basic TypeScript agent
|
|
65
|
+
- `chatbot-js` - JavaScript chatbot agent
|
|
66
|
+
- `chatbot-ts` - TypeScript chatbot agent
|
|
67
|
+
|
|
68
|
+
### 5. Deploy Your Agent
|
|
69
|
+
|
|
70
|
+
From your agent directory:
|
|
71
|
+
```bash
|
|
72
|
+
nestbox agent deploy
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
List deployed agents:
|
|
76
|
+
```bash
|
|
77
|
+
nestbox agent list
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
Remove an agent:
|
|
81
|
+
```bash
|
|
82
|
+
nestbox agent remove
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
## Common Workflows
|
|
86
|
+
|
|
87
|
+
### Development Cycle
|
|
88
|
+
```bash
|
|
89
|
+
# Generate agent project
|
|
90
|
+
nestbox generate project my-agent
|
|
91
|
+
|
|
92
|
+
# Develop locally
|
|
93
|
+
cd my-agent
|
|
94
|
+
npm install
|
|
95
|
+
npm run dev
|
|
96
|
+
|
|
97
|
+
# Deploy to staging
|
|
98
|
+
nestbox agent deploy --env staging
|
|
99
|
+
|
|
100
|
+
# Test and validate
|
|
101
|
+
nestbox agent list
|
|
102
|
+
|
|
103
|
+
# Deploy to production
|
|
104
|
+
nestbox agent deploy --env production
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
### Managing Documents
|
|
108
|
+
```bash
|
|
109
|
+
# Upload documents for agent context
|
|
110
|
+
nestbox document upload ./docs/*.pdf
|
|
111
|
+
|
|
112
|
+
# List uploaded documents
|
|
113
|
+
nestbox document list
|
|
114
|
+
|
|
115
|
+
# Delete documents
|
|
116
|
+
nestbox document delete <document-id>
|
|
117
|
+
```
|
|
118
|
+
|
|
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
|
+
## Configuration
|
|
132
|
+
|
|
133
|
+
The CLI stores configuration in `.nestboxrc` in your home directory. You can also use project-specific configuration by creating a `nestbox.config.json` file:
|
|
134
|
+
|
|
135
|
+
```json
|
|
136
|
+
{
|
|
137
|
+
"project": "your-project-id",
|
|
138
|
+
"defaultCompute": "your-compute-id",
|
|
139
|
+
"environment": "staging"
|
|
140
|
+
}
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
## Help & Documentation
|
|
144
|
+
|
|
145
|
+
Get help for any command:
|
|
146
|
+
```bash
|
|
147
|
+
nestbox --help
|
|
148
|
+
nestbox agent --help
|
|
149
|
+
nestbox project --help
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
## Next Steps
|
|
153
|
+
|
|
154
|
+
- Check out the [Nestbox AI developers site](https://developers.nestbox.ai) for detailed documentation
|
|
155
|
+
- Explore the example agents in the templates directory
|
|
156
|
+
- Join our developer community for support and best practices
|
|
157
|
+
|
|
158
|
+
Happy building! 🚀
|