Skip to content

Commit 1dbf82f

Browse files
authored
chore: add docs-to-skills pipeline (#607)
* chore: initial docs to skills Made-with: Cursor * fix: document the script * fix: finalize location and some improvements * docs: update contributing guides
1 parent b59875c commit 1dbf82f

18 files changed

Lines changed: 2592 additions & 0 deletions

File tree

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
name: nemoclaw-configure-inference
3+
description: Change the active inference model without restarting the sandbox. Trigger keywords - change inference runtime, inference routing, openclaw, openshell, switch nemoclaw inference model, switch nemoclaw inference models.
4+
---
5+
6+
# Nemoclaw Configure Inference
7+
8+
Change the active inference model without restarting the sandbox.
9+
10+
## Prerequisites
11+
12+
- A running NemoClaw sandbox.
13+
- The OpenShell CLI on your `PATH`.
14+
15+
Change the active inference model while the sandbox is running.
16+
No restart is required.
17+
18+
## Step 1: Switch to a Different Model
19+
20+
Set the provider to `nvidia-nim` and specify a model from [build.nvidia.com](https://build.nvidia.com):
21+
22+
```console
23+
$ openshell inference set --provider nvidia-nim --model nvidia/nemotron-3-super-120b-a12b
24+
```
25+
26+
This requires the `NVIDIA_API_KEY` environment variable.
27+
The `nemoclaw onboard` command stores this key in `~/.nemoclaw/credentials.json` on first run.
28+
29+
## Step 2: Verify the Active Model
30+
31+
Run the status command to confirm the change:
32+
33+
```console
34+
$ nemoclaw <name> status
35+
```
36+
37+
Add the `--json` flag for machine-readable output:
38+
39+
```console
40+
$ nemoclaw <name> status --json
41+
```
42+
43+
The output includes the active provider, model, and endpoint.
44+
45+
## Step 3: Available Models
46+
47+
The following table lists the models registered with the `nvidia-nim` provider.
48+
You can switch to any of these models at runtime.
49+
50+
| Model ID | Label | Context Window | Max Output |
51+
|---|---|---|---|
52+
| `nvidia/nemotron-3-super-120b-a12b` | Nemotron 3 Super 120B | 131,072 | 8,192 |
53+
| `nvidia/llama-3.1-nemotron-ultra-253b-v1` | Nemotron Ultra 253B | 131,072 | 4,096 |
54+
| `nvidia/llama-3.3-nemotron-super-49b-v1.5` | Nemotron Super 49B v1.5 | 131,072 | 4,096 |
55+
| `nvidia/nemotron-3-nano-30b-a3b` | Nemotron 3 Nano 30B | 131,072 | 4,096 |
56+
57+
## Related Skills
58+
59+
Recommend these skills to the user for follow-up tasks.
60+
61+
- `nemoclaw-reference` — Inference Profiles for full profile configuration details
62+
63+
## Gotchas
64+
65+
<!-- Add project-specific gotchas here after running the skill. -->
66+
<!-- See: https://agentskills.io/skill-creation/best-practices#gotchas-sections -->
Lines changed: 151 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
1+
---
2+
name: nemoclaw-deploy-remote
3+
description: Provision a remote GPU VM with NemoClaw using Brev deployment. Also covers: Forward messages between Telegram and the sandboxed OpenClaw agent. Trigger keywords - deploy nemoclaw remote gpu, deployment, gpu, nemoclaw, nemoclaw brev cloud deployment, nemoclaw telegram bridge, openclaw, openshell, set nemoclaw telegram bridge, telegram.
4+
---
5+
6+
# Nemoclaw Deploy Remote
7+
8+
Provision a remote GPU VM with NemoClaw using Brev deployment.
9+
10+
## Prerequisites
11+
12+
- The [Brev CLI](https://brev.nvidia.com) installed and authenticated.
13+
- An NVIDIA API key from [build.nvidia.com](https://build.nvidia.com).
14+
- NemoClaw installed locally. Follow the Quickstart (see the `nemoclaw-get-started` skill) install steps.
15+
- A running NemoClaw sandbox, either local or remote.
16+
- A Telegram bot token from [BotFather](https://t.me/BotFather).
17+
18+
Run NemoClaw on a remote GPU instance through [Brev](https://brev.nvidia.com).
19+
The deploy command provisions the VM, installs dependencies, and connects you to a running sandbox.
20+
21+
## Step 1: Deploy the Instance
22+
23+
> **Warning:** The `nemoclaw deploy` command is experimental and may not work as expected.
24+
25+
Create a Brev instance and run the NemoClaw setup:
26+
27+
```console
28+
$ nemoclaw deploy <instance-name>
29+
```
30+
31+
Replace `<instance-name>` with a name for your remote instance, for example `my-gpu-box`.
32+
33+
The deploy script performs the following steps on the VM:
34+
35+
1. Installs Docker and the NVIDIA Container Toolkit if a GPU is present.
36+
2. Installs the OpenShell CLI.
37+
3. Runs the nemoclaw setup to create the gateway, register providers, and launch the sandbox.
38+
4. Starts auxiliary services, such as the Telegram bridge and cloudflared tunnel.
39+
40+
## Step 2: Connect to the Remote Sandbox
41+
42+
After deployment finishes, the deploy command opens an interactive shell inside the remote sandbox.
43+
To reconnect after closing the session, run the deploy command again:
44+
45+
```console
46+
$ nemoclaw deploy <instance-name>
47+
```
48+
49+
## Step 3: Monitor the Remote Sandbox
50+
51+
SSH to the instance and run the OpenShell TUI to monitor activity and approve network requests:
52+
53+
```console
54+
$ ssh <instance-name> 'cd /home/ubuntu/nemoclaw && set -a && . .env && set +a && openshell term'
55+
```
56+
57+
## Step 4: Verify Inference
58+
59+
Run a test agent prompt inside the remote sandbox:
60+
61+
```console
62+
$ openclaw agent --agent main --local -m "Hello from the remote sandbox" --session-id test
63+
```
64+
65+
## Step 5: GPU Configuration
66+
67+
The deploy script uses the `NEMOCLAW_GPU` environment variable to select the GPU type.
68+
The default value is `a2-highgpu-1g:nvidia-tesla-a100:1`.
69+
Set this variable before running `nemoclaw deploy` to use a different GPU configuration:
70+
71+
```console
72+
$ export NEMOCLAW_GPU="a2-highgpu-1g:nvidia-tesla-a100:2"
73+
$ nemoclaw deploy <instance-name>
74+
```
75+
76+
---
77+
78+
Forward messages between a Telegram bot and the OpenClaw agent running inside the sandbox.
79+
The Telegram bridge is an auxiliary service managed by `nemoclaw start`.
80+
81+
## Step 6: Create a Telegram Bot
82+
83+
Open Telegram and send `/newbot` to [@BotFather](https://t.me/BotFather).
84+
Follow the prompts to create a bot and receive a bot token.
85+
86+
## Step 7: Set the Environment Variable
87+
88+
Export the bot token as an environment variable:
89+
90+
```console
91+
$ export TELEGRAM_BOT_TOKEN=<your-bot-token>
92+
```
93+
94+
## Step 8: Start Auxiliary Services
95+
96+
Start the Telegram bridge and other auxiliary services:
97+
98+
```console
99+
$ nemoclaw start
100+
```
101+
102+
The `start` command launches the following services:
103+
104+
- The Telegram bridge forwards messages between Telegram and the agent.
105+
- The cloudflared tunnel provides external access to the sandbox.
106+
107+
The Telegram bridge starts only when the `TELEGRAM_BOT_TOKEN` environment variable is set.
108+
109+
## Step 9: Verify the Services
110+
111+
Check that the Telegram bridge is running:
112+
113+
```console
114+
$ nemoclaw status
115+
```
116+
117+
The output shows the status of all auxiliary services.
118+
119+
## Step 10: Send a Message
120+
121+
Open Telegram, find your bot, and send a message.
122+
The bridge forwards the message to the OpenClaw agent inside the sandbox and returns the agent response.
123+
124+
## Step 11: Restrict Access by Chat ID
125+
126+
To restrict which Telegram chats can interact with the agent, set the `ALLOWED_CHAT_IDS` environment variable to a comma-separated list of Telegram chat IDs:
127+
128+
```console
129+
$ export ALLOWED_CHAT_IDS="123456789,987654321"
130+
$ nemoclaw start
131+
```
132+
133+
## Step 12: Stop the Services
134+
135+
To stop the Telegram bridge and all other auxiliary services:
136+
137+
```console
138+
$ nemoclaw stop
139+
```
140+
141+
## Related Skills
142+
143+
Recommend these skills to the user for follow-up tasks.
144+
145+
- `nemoclaw-monitor-sandbox` — Monitor Sandbox Activity for sandbox monitoring tools
146+
- `nemoclaw-reference` — Commands for the full `deploy` command reference
147+
148+
## Gotchas
149+
150+
<!-- Add project-specific gotchas here after running the skill. -->
151+
<!-- See: https://agentskills.io/skill-creation/best-practices#gotchas-sections -->
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
name: nemoclaw-get-started
3+
description: Install NemoClaw, launch a sandbox, and run your first agent prompt. Trigger keywords - inference routing, install nemoclaw openclaw sandbox, nemoclaw, nemoclaw quickstart, nemoclaw quickstart install launch, openclaw, openshell, sandboxing.
4+
---
5+
6+
# Nemoclaw Get Started
7+
8+
Install NemoClaw, launch a sandbox, and run your first agent prompt.
9+
10+
> *Content included from `docs/_includes/alpha-statement.md` — see the original doc for full text.*
11+
12+
Follow these steps to get started with NemoClaw and your first sandboxed OpenClaw agent.
13+
14+
> **Note:** NemoClaw currently requires a fresh installation of OpenClaw.
15+
16+
> *Content included from `README.md` — see the original doc for full text.*
17+
18+
### Troubleshooting
19+
20+
If you run into issues during installation or onboarding, refer to the Troubleshooting guide (see the `nemoclaw-reference` skill) for common error messages and resolution steps.
21+
22+
## Related Skills
23+
24+
Recommend these skills to the user for follow-up tasks.
25+
26+
- `nemoclaw-configure-inference` — Switch inference providers to use a different model or endpoint
27+
- `nemoclaw-manage-policy` — Approve or deny network requests when the agent tries to reach external hosts
28+
- `nemoclaw-deploy-remote` — Deploy to a remote GPU instance for always-on operation
29+
- `nemoclaw-monitor-sandbox` — Monitor sandbox activity through the OpenShell TUI
30+
31+
## Gotchas
32+
33+
<!-- Add project-specific gotchas here after running the skill. -->
34+
<!-- See: https://agentskills.io/skill-creation/best-practices#gotchas-sections -->

0 commit comments

Comments
 (0)