@@ -6,54 +6,55 @@ Agentic coding CLI for [NVIDIA NIM](https://build.nvidia.com). Reads your code,
66
77## Install
88
9- From source (editable) :
9+ From PyPI :
1010``` bash
11- pip install -e .
11+ pip install nemocode
1212```
1313
14- Or from PyPI :
14+ Or from source (editable) :
1515``` bash
16- pip install nemocode
16+ pip install -e .
1717```
1818
19- ## Setup
19+ ## Quick Start
2020
2121Run the guided setup wizard:
2222
2323``` bash
2424nemo setup
2525```
2626
27- It defaults to hosted NVIDIA NIM, prompts for ` NVIDIA_API_KEY ` , and can also configure a local ` vllm ` or ` sglang ` endpoint and model for you.
27+ The wizard defaults to ** hosted NVIDIA NIM** , prompts for ` NVIDIA_API_KEY ` , and can also configure a local ` vllm ` or ` sglang ` backend for you.
28+
29+ ### Hosted NVIDIA NIM (default)
2830
29- If you just want hosted NIM manually, get a free API key from [ build.nvidia.com] ( https://build.nvidia.com ) :
31+ Get a free API key from [ build.nvidia.com] ( https://build.nvidia.com ) :
3032
3133``` bash
3234export NVIDIA_API_KEY=" nvapi-..."
3335nemo code
3436```
3537
36- Hosted Nemotron/NIM endpoints in NeMoCode use ` NVIDIA_API_KEY ` by default.
38+ Hosted Nemotron endpoints use ` NVIDIA_API_KEY ` by default. The setup wizard can store it in your system keyring .
3739
38- Or serve a model locally with [ vLLM] ( https://docs.vllm.ai/ ) or [ SGLang] ( https://sgl-project.github.io/ ) on any NVIDIA GPU:
40+ ### Local vLLM or SGLang
41+
42+ Serve a model locally on any NVIDIA GPU:
3943
4044``` bash
4145# vLLM
4246vllm serve nvidia/NVIDIA-Nemotron-Nano-9B-v2 \
43- --trust-remote-code --mamba_ssm_cache_dtype float32 \
44- --enable-auto-tool-choice \
45- --tool-parser-plugin nemotron_toolcall_parser.py \
46- --tool-call-parser nemotron_json
47+ --host 0.0.0.0 --port 8000
4748nemo code -e local-vllm-nano9b
4849
4950# SGLang (best for Nemotron 3 Super long context on DGX Spark)
5051python -m sglang.launch_server \
5152 --model nvidia/nemotron-3-super-120b-a12b \
52- --quantization nvfp4 --trust-remote-code
53- nemo code -e spark -sglang-super
53+ --host 0.0.0.0 --port 8000
54+ nemo code -e local -sglang-super
5455```
5556
56- No GPU? Rent one via [ Brev] ( https://console.brev.dev ) — L40S from $1.03/hr :
57+ No GPU? Rent one via [ Brev] ( https://console.brev.dev ) :
5758
5859``` bash
5960nemo setup brev
@@ -67,8 +68,32 @@ nemo code "fix the bug in auth.py" -y # one-shot, auto-approve tools
6768nemo chat " explain this error" # chat, no tools
6869cat log.txt | nemo code " diagnose" # pipe input
6970nemo code -f super-nano " refactor" # multi-model formation
71+ nemo code --tui # full-screen TUI
72+ ```
73+
74+ ## Plan Mode
75+
76+ Plan mode is a read-only planning phase with an approval gate before execution.
77+
78+ - ** Read-only** : Plan mode only reads files, searches code, and explores — no writes, shell commands, or commits.
79+ - ** Approval gate** : The planner proposes a concrete plan. You review and approve, revise with feedback, or cancel.
80+ - ** Execution** : Once approved, a build agent executes the plan with full tool access.
81+
82+ Switch modes in the REPL with Tab or ` /mode ` :
83+
84+ | Mode | Behavior |
85+ | ------| ----------|
86+ | ` code ` | Ask before tool calls (default) |
87+ | ` plan ` | Read-only planning + approval gate |
88+ | ` auto ` | Auto-approve everything |
89+
90+ Launch directly in plan mode:
91+ ``` bash
92+ nemo code --agent plan " implement user auth"
7093```
7194
95+ The plan agent can also spawn read-only research subagents to help with exploration.
96+
7297## Endpoints
7398
7499Works with any OpenAI-compatible API. Pre-configured:
@@ -78,7 +103,7 @@ Works with any OpenAI-compatible API. Pre-configured:
78103| ` nim-super ` | Nemotron 3 Super (12B/120B MoE, 1M ctx) | NIM API key |
79104| ` nim-nano ` | Nemotron 3 Nano (3B/30B MoE, 1M ctx) | NIM API key |
80105| ` nim-nano-9b ` | Nemotron Nano 9B v2 | NIM API key |
81- | ` nim-nano-4b ` | Nemotron Nano 4B v1.1 (new!) | NIM API key |
106+ | ` nim-nano-4b ` | Nemotron Nano 4B v1.1 | NIM API key |
82107| ` nim-vlm ` | Nemotron Nano 12B VL (vision) | NIM API key |
83108| ` nim-embed ` | Nemotron Embed 1B v2 | NIM API key |
84109| ` nim-rerank ` | Nemotron Rerank 1B v2 | NIM API key |
@@ -105,18 +130,32 @@ nemo code -f super-nano "implement caching"
105130| ` vision ` | VLM reads screenshots, Super writes code |
106131| ` local ` | Nano on local GPU, no internet needed |
107132
108- ## Agents
133+ ## Agents & Sub-agent Orchestration
109134
110- NeMoCode now supports named agent profiles for top-level sessions and delegated sub-agents.
135+ NeMoCode supports named agent profiles for top-level sessions and delegated sub-agents.
111136
112- - Built-in primary agents: ` build ` , ` plan `
113- - Built-in sub- agents: ` general ` , ` explore ` , ` review ` , ` debug ` , ` test ` , ` doc ` , ` code-search ` , ` fast `
137+ - ** Primary agents** : ` build ` (default full-access) , ` plan ` (read-only planning)
138+ - ** Sub- agents** : ` general ` , ` explore ` , ` review ` , ` debug ` , ` test ` , ` doc ` , ` code-search ` , ` fast `
114139- Inspect them with ` nemo agent ls ` and ` nemo agent show <name> `
115140- Switch primary agents with ` nemo code --agent <name> ` or ` /agent <name> ` in the REPL/TUI
116- - Sub-agent orchestration tools are now available in coding sessions: ` delegate ` , ` spawn_agent ` , ` wait_agent ` , ` close_agent ` , and ` resume_agent `
117- - Define custom agents in ` .nemocode.yaml ` under ` agents: ` or in markdown files under ` .nemocode/agents/*.md `
118141
119- Example markdown agent:
142+ ### Sub-agent tools
143+
144+ In coding sessions, these orchestration tools are available:
145+
146+ | Tool | Purpose |
147+ | ------| ---------|
148+ | ` delegate ` | Spawn a sub-agent and wait for the result |
149+ | ` spawn_agent ` | Spawn a background sub-agent for parallel work |
150+ | ` wait_agent ` | Wait for a spawned sub-agent to finish |
151+ | ` close_agent ` | Close or cancel a sub-agent handle |
152+ | ` resume_agent ` | Reopen a previously closed sub-agent handle |
153+
154+ Sub-agents inherit read-only mode when delegated from plan mode.
155+
156+ ### Custom agents
157+
158+ Define custom agents in ` .nemocode.yaml ` under ` agents: ` or as markdown files under ` .nemocode/agents/*.md ` :
120159
121160``` markdown
122161---
@@ -134,7 +173,7 @@ tools:
134173Review the requested changes. Focus on correctness, regressions, and missing tests.
135174```
136175
137- ## Local GPU setup
176+ ## Setup Commands
138177
139178``` bash
140179nemo setup # guided wizard
@@ -146,7 +185,7 @@ nemo setup nim # NIM container guide
146185nemo setup brev # rent a cloud GPU
147186```
148187
149- ## More commands
188+ ## More Commands
150189
151190``` bash
152191nemo endpoint ls / test # manage endpoints
@@ -157,7 +196,7 @@ nemo hardware recommend # GPU-based recommendations
157196nemo doctor # run diagnostics to check setup
158197nemo session ls # past conversations
159198nemo obs pricing # token pricing
160- nemo init # create .nemocode.yaml without overriding your user default endpoint
199+ nemo init # create .nemocode.yaml without overriding user defaults
161200```
162201
163202## Contributing
0 commit comments