-
Notifications
You must be signed in to change notification settings - Fork 2.4k
chore: add docs-to-skills pipeline #607
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| --- | ||
| name: nemoclaw-configure-inference | ||
| 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. | ||
| --- | ||
|
|
||
| # Nemoclaw Configure Inference | ||
|
|
||
| Change the active inference model without restarting the sandbox. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - A running NemoClaw sandbox. | ||
| - The OpenShell CLI on your `PATH`. | ||
|
|
||
| Change the active inference model while the sandbox is running. | ||
| No restart is required. | ||
|
|
||
| ## Step 1: Switch to a Different Model | ||
|
|
||
| Set the provider to `nvidia-nim` and specify a model from [build.nvidia.com](https://build.nvidia.com): | ||
|
|
||
| ```console | ||
| $ openshell inference set --provider nvidia-nim --model nvidia/nemotron-3-super-120b-a12b | ||
| ``` | ||
|
|
||
| This requires the `NVIDIA_API_KEY` environment variable. | ||
| The `nemoclaw onboard` command stores this key in `~/.nemoclaw/credentials.json` on first run. | ||
|
|
||
| ## Step 2: Verify the Active Model | ||
|
|
||
| Run the status command to confirm the change: | ||
|
|
||
| ```console | ||
| $ nemoclaw <name> status | ||
| ``` | ||
|
|
||
| Add the `--json` flag for machine-readable output: | ||
|
|
||
| ```console | ||
| $ nemoclaw <name> status --json | ||
| ``` | ||
|
|
||
| The output includes the active provider, model, and endpoint. | ||
|
|
||
| ## Step 3: Available Models | ||
|
|
||
| The following table lists the models registered with the `nvidia-nim` provider. | ||
| You can switch to any of these models at runtime. | ||
|
|
||
| | Model ID | Label | Context Window | Max Output | | ||
| |---|---|---|---| | ||
| | `nvidia/nemotron-3-super-120b-a12b` | Nemotron 3 Super 120B | 131,072 | 8,192 | | ||
| | `nvidia/llama-3.1-nemotron-ultra-253b-v1` | Nemotron Ultra 253B | 131,072 | 4,096 | | ||
| | `nvidia/llama-3.3-nemotron-super-49b-v1.5` | Nemotron Super 49B v1.5 | 131,072 | 4,096 | | ||
| | `nvidia/nemotron-3-nano-30b-a3b` | Nemotron 3 Nano 30B | 131,072 | 4,096 | | ||
|
|
||
| ## Related Skills | ||
|
|
||
| Recommend these skills to the user for follow-up tasks. | ||
|
|
||
| - `nemoclaw-reference` — Inference Profiles for full profile configuration details | ||
|
|
||
| ## Gotchas | ||
|
|
||
| <!-- Add project-specific gotchas here after running the skill. --> | ||
| <!-- See: https://agentskills.io/skill-creation/best-practices#gotchas-sections --> | ||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,151 @@ | ||||||
| --- | ||||||
| name: nemoclaw-deploy-remote | ||||||
| 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. | ||||||
| --- | ||||||
|
|
||||||
| # Nemoclaw Deploy Remote | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Use correct casing for NemoClaw in the heading. The heading uses "Nemoclaw" but should be "NemoClaw" with a capital C. As per coding guidelines, "NemoClaw, OpenClaw, and OpenShell must use correct casing." ✏️ Proposed fix-# Nemoclaw Deploy Remote
+# NemoClaw Deploy Remote📝 Committable suggestion
Suggested change
🤖 Prompt for AI Agents |
||||||
|
|
||||||
| Provision a remote GPU VM with NemoClaw using Brev deployment. | ||||||
|
|
||||||
| ## Prerequisites | ||||||
|
|
||||||
| - The [Brev CLI](https://brev.nvidia.com) installed and authenticated. | ||||||
| - An NVIDIA API key from [build.nvidia.com](https://build.nvidia.com). | ||||||
| - NemoClaw installed locally. Follow the Quickstart (see the `nemoclaw-get-started` skill) install steps. | ||||||
| - A running NemoClaw sandbox, either local or remote. | ||||||
| - A Telegram bot token from [BotFather](https://t.me/BotFather). | ||||||
|
|
||||||
| Run NemoClaw on a remote GPU instance through [Brev](https://brev.nvidia.com). | ||||||
| The deploy command provisions the VM, installs dependencies, and connects you to a running sandbox. | ||||||
|
|
||||||
| ## Step 1: Deploy the Instance | ||||||
|
|
||||||
| > **Warning:** The `nemoclaw deploy` command is experimental and may not work as expected. | ||||||
|
|
||||||
| Create a Brev instance and run the NemoClaw setup: | ||||||
|
|
||||||
| ```console | ||||||
| $ nemoclaw deploy <instance-name> | ||||||
| ``` | ||||||
|
|
||||||
| Replace `<instance-name>` with a name for your remote instance, for example `my-gpu-box`. | ||||||
|
|
||||||
| The deploy script performs the following steps on the VM: | ||||||
|
|
||||||
| 1. Installs Docker and the NVIDIA Container Toolkit if a GPU is present. | ||||||
| 2. Installs the OpenShell CLI. | ||||||
| 3. Runs the nemoclaw setup to create the gateway, register providers, and launch the sandbox. | ||||||
| 4. Starts auxiliary services, such as the Telegram bridge and cloudflared tunnel. | ||||||
|
|
||||||
| ## Step 2: Connect to the Remote Sandbox | ||||||
|
|
||||||
| After deployment finishes, the deploy command opens an interactive shell inside the remote sandbox. | ||||||
| To reconnect after closing the session, run the deploy command again: | ||||||
|
|
||||||
| ```console | ||||||
| $ nemoclaw deploy <instance-name> | ||||||
| ``` | ||||||
|
|
||||||
| ## Step 3: Monitor the Remote Sandbox | ||||||
|
|
||||||
| SSH to the instance and run the OpenShell TUI to monitor activity and approve network requests: | ||||||
|
|
||||||
| ```console | ||||||
| $ ssh <instance-name> 'cd /home/ubuntu/nemoclaw && set -a && . .env && set +a && openshell term' | ||||||
| ``` | ||||||
|
|
||||||
| ## Step 4: Verify Inference | ||||||
|
|
||||||
| Run a test agent prompt inside the remote sandbox: | ||||||
|
|
||||||
| ```console | ||||||
| $ openclaw agent --agent main --local -m "Hello from the remote sandbox" --session-id test | ||||||
| ``` | ||||||
|
|
||||||
| ## Step 5: GPU Configuration | ||||||
|
|
||||||
| The deploy script uses the `NEMOCLAW_GPU` environment variable to select the GPU type. | ||||||
| The default value is `a2-highgpu-1g:nvidia-tesla-a100:1`. | ||||||
| Set this variable before running `nemoclaw deploy` to use a different GPU configuration: | ||||||
|
|
||||||
| ```console | ||||||
| $ export NEMOCLAW_GPU="a2-highgpu-1g:nvidia-tesla-a100:2" | ||||||
| $ nemoclaw deploy <instance-name> | ||||||
| ``` | ||||||
|
|
||||||
| --- | ||||||
|
|
||||||
| Forward messages between a Telegram bot and the OpenClaw agent running inside the sandbox. | ||||||
| The Telegram bridge is an auxiliary service managed by `nemoclaw start`. | ||||||
|
|
||||||
| ## Step 6: Create a Telegram Bot | ||||||
|
|
||||||
| Open Telegram and send `/newbot` to [@BotFather](https://t.me/BotFather). | ||||||
| Follow the prompts to create a bot and receive a bot token. | ||||||
|
|
||||||
| ## Step 7: Set the Environment Variable | ||||||
|
|
||||||
| Export the bot token as an environment variable: | ||||||
|
|
||||||
| ```console | ||||||
| $ export TELEGRAM_BOT_TOKEN=<your-bot-token> | ||||||
| ``` | ||||||
|
|
||||||
| ## Step 8: Start Auxiliary Services | ||||||
|
|
||||||
| Start the Telegram bridge and other auxiliary services: | ||||||
|
|
||||||
| ```console | ||||||
| $ nemoclaw start | ||||||
| ``` | ||||||
|
|
||||||
| The `start` command launches the following services: | ||||||
|
|
||||||
| - The Telegram bridge forwards messages between Telegram and the agent. | ||||||
| - The cloudflared tunnel provides external access to the sandbox. | ||||||
|
|
||||||
| The Telegram bridge starts only when the `TELEGRAM_BOT_TOKEN` environment variable is set. | ||||||
|
|
||||||
| ## Step 9: Verify the Services | ||||||
|
|
||||||
| Check that the Telegram bridge is running: | ||||||
|
|
||||||
| ```console | ||||||
| $ nemoclaw status | ||||||
| ``` | ||||||
|
|
||||||
| The output shows the status of all auxiliary services. | ||||||
|
|
||||||
| ## Step 10: Send a Message | ||||||
|
|
||||||
| Open Telegram, find your bot, and send a message. | ||||||
| The bridge forwards the message to the OpenClaw agent inside the sandbox and returns the agent response. | ||||||
|
|
||||||
| ## Step 11: Restrict Access by Chat ID | ||||||
|
|
||||||
| 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: | ||||||
|
|
||||||
| ```console | ||||||
| $ export ALLOWED_CHAT_IDS="123456789,987654321" | ||||||
| $ nemoclaw start | ||||||
| ``` | ||||||
|
|
||||||
| ## Step 12: Stop the Services | ||||||
|
|
||||||
| To stop the Telegram bridge and all other auxiliary services: | ||||||
|
|
||||||
| ```console | ||||||
| $ nemoclaw stop | ||||||
| ``` | ||||||
|
|
||||||
| ## Related Skills | ||||||
|
|
||||||
| Recommend these skills to the user for follow-up tasks. | ||||||
|
|
||||||
| - `nemoclaw-monitor-sandbox` — Monitor Sandbox Activity for sandbox monitoring tools | ||||||
| - `nemoclaw-reference` — Commands for the full `deploy` command reference | ||||||
|
|
||||||
| ## Gotchas | ||||||
|
|
||||||
| <!-- Add project-specific gotchas here after running the skill. --> | ||||||
| <!-- See: https://agentskills.io/skill-creation/best-practices#gotchas-sections --> | ||||||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,34 @@ | ||||||
| --- | ||||||
| name: nemoclaw-get-started | ||||||
| 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. | ||||||
| --- | ||||||
|
|
||||||
| # Nemoclaw Get Started | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Use correct casing for NemoClaw in the heading. The heading uses "Nemoclaw" but should be "NemoClaw" with a capital C. As per coding guidelines, "NemoClaw, OpenClaw, and OpenShell must use correct casing." ✏️ Proposed fix-# Nemoclaw Get Started
+# NemoClaw Get Started📝 Committable suggestion
Suggested change
🤖 Prompt for AI Agents |
||||||
|
|
||||||
| Install NemoClaw, launch a sandbox, and run your first agent prompt. | ||||||
|
|
||||||
| > *Content included from `docs/_includes/alpha-statement.md` — see the original doc for full text.* | ||||||
|
|
||||||
| Follow these steps to get started with NemoClaw and your first sandboxed OpenClaw agent. | ||||||
|
|
||||||
| > **Note:** NemoClaw currently requires a fresh installation of OpenClaw. | ||||||
|
|
||||||
| > *Content included from `README.md` — see the original doc for full text.* | ||||||
|
|
||||||
| ### Troubleshooting | ||||||
|
|
||||||
| 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. | ||||||
|
|
||||||
| ## Related Skills | ||||||
|
|
||||||
| Recommend these skills to the user for follow-up tasks. | ||||||
|
|
||||||
| - `nemoclaw-configure-inference` — Switch inference providers to use a different model or endpoint | ||||||
| - `nemoclaw-manage-policy` — Approve or deny network requests when the agent tries to reach external hosts | ||||||
| - `nemoclaw-deploy-remote` — Deploy to a remote GPU instance for always-on operation | ||||||
| - `nemoclaw-monitor-sandbox` — Monitor sandbox activity through the OpenShell TUI | ||||||
|
|
||||||
| ## Gotchas | ||||||
|
|
||||||
| <!-- Add project-specific gotchas here after running the skill. --> | ||||||
| <!-- See: https://agentskills.io/skill-creation/best-practices#gotchas-sections --> | ||||||
Uh oh!
There was an error while loading. Please reload this page.