neuroncli 6.2.3__tar.gz → 7.0.0a3__tar.gz
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.
- neuroncli-7.0.0a3/LICENSE +22 -0
- neuroncli-7.0.0a3/NOTICE +96 -0
- neuroncli-7.0.0a3/PKG-INFO +312 -0
- neuroncli-7.0.0a3/README.md +286 -0
- neuroncli-7.0.0a3/neuron_cli/__init__.py +402 -0
- neuroncli-7.0.0a3/neuroncli.egg-info/PKG-INFO +312 -0
- {neuroncli-6.2.3 → neuroncli-7.0.0a3}/neuroncli.egg-info/SOURCES.txt +8 -2
- {neuroncli-6.2.3 → neuroncli-7.0.0a3}/pyproject.toml +40 -37
- {neuroncli-6.2.3 → neuroncli-7.0.0a3}/setup.cfg +4 -4
- neuroncli-7.0.0a3/tests/test_install_scripts.py +838 -0
- neuroncli-7.0.0a3/tests/test_npm_package.py +135 -0
- neuroncli-7.0.0a3/tests/test_packaged_launcher.py +352 -0
- neuroncli-7.0.0a3/tests/test_packaging_metadata.py +230 -0
- {neuroncli-6.2.3 → neuroncli-7.0.0a3}/tests/test_porting_workspace.py +275 -248
- neuroncli-7.0.0a3/tests/test_release_workflow.py +382 -0
- neuroncli-6.2.3/PKG-INFO +0 -151
- neuroncli-6.2.3/README.md +0 -133
- neuroncli-6.2.3/neuron_cli/__init__.py +0 -100
- neuroncli-6.2.3/neuron_cli/neuron.exe +0 -0
- neuroncli-6.2.3/neuroncli.egg-info/PKG-INFO +0 -151
- {neuroncli-6.2.3 → neuroncli-7.0.0a3}/neuroncli.egg-info/dependency_links.txt +0 -0
- {neuroncli-6.2.3 → neuroncli-7.0.0a3}/neuroncli.egg-info/entry_points.txt +0 -0
- {neuroncli-6.2.3 → neuroncli-7.0.0a3}/neuroncli.egg-info/top_level.txt +0 -0
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 UltraWorkers and Claw Code contributors
|
|
4
|
+
Copyright (c) 2026 RAHUL S / Zero-X
|
|
5
|
+
|
|
6
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
7
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
8
|
+
in the Software without restriction, including without limitation the rights
|
|
9
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
10
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
11
|
+
furnished to do so, subject to the following conditions:
|
|
12
|
+
|
|
13
|
+
The above copyright notice and this permission notice shall be included in all
|
|
14
|
+
copies or substantial portions of the Software.
|
|
15
|
+
|
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
17
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
18
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
19
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
20
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
21
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
22
|
+
SOFTWARE.
|
neuroncli-7.0.0a3/NOTICE
ADDED
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
Neuron (https://github.com/RAHUL-DevelopeRR/neuron-v2)
|
|
2
|
+
Copyright (c) 2026 RAHUL S / Zero-X
|
|
3
|
+
|
|
4
|
+
Neuron is distributed under the MIT License; see LICENSE. The full-screen UI
|
|
5
|
+
(ui/neuron-tui, released as the neuron-tui binaries) is distributed under the
|
|
6
|
+
Apache License, Version 2.0; see below.
|
|
7
|
+
|
|
8
|
+
Provenance
|
|
9
|
+
----------
|
|
10
|
+
|
|
11
|
+
Neuron is derived from Claw Code (https://github.com/ultraworkers/claw-code),
|
|
12
|
+
which is distributed under the MIT License:
|
|
13
|
+
|
|
14
|
+
Copyright (c) 2026 UltraWorkers and Claw Code contributors
|
|
15
|
+
|
|
16
|
+
The Rust workspace under rust/ (including the rusty-claude-cli crate that builds
|
|
17
|
+
the `neuron` binary), the Python porting workspace under src/ and tests/, and
|
|
18
|
+
the parity documents were imported from Claw Code and have since been modified.
|
|
19
|
+
The Claw Code copyright and permission notice is reproduced in LICENSE and must
|
|
20
|
+
be kept in all copies or substantial portions of the software. See
|
|
21
|
+
docs/PROVENANCE.md for the code lineage.
|
|
22
|
+
|
|
23
|
+
Full-screen UI (neuron-tui)
|
|
24
|
+
---------------------------
|
|
25
|
+
|
|
26
|
+
The full-screen terminal UI under ui/neuron-tui, released as the neuron-tui
|
|
27
|
+
binaries, is derived from the Freebuff CLI (its cli/ package, and 31 files of its
|
|
28
|
+
common/src vendored under ui/neuron-tui/src/vendor/common) at
|
|
29
|
+
https://github.com/CodebuffAI/freebuff commit 545e04d, and has since been
|
|
30
|
+
modified: Codebuff's services, ads, billing and telemetry were removed. It is
|
|
31
|
+
distributed under the Apache License, Version 2.0, whose full text is in
|
|
32
|
+
ui/neuron-tui/LICENSE. Files changed from the originals start with a
|
|
33
|
+
"Derived from Codebuff/Freebuff (Apache-2.0); modified for Neuron" notice. The
|
|
34
|
+
Freebuff NOTICE file reads:
|
|
35
|
+
|
|
36
|
+
Codebuff
|
|
37
|
+
Copyright 2025 Codebuff
|
|
38
|
+
|
|
39
|
+
This product includes software developed for the Codebuff project.
|
|
40
|
+
|
|
41
|
+
The neuron-tui binary is compiled with Bun and contains the Bun runtime and npm
|
|
42
|
+
packages, among them OpenTUI and React. THIRD_PARTY_NOTICES.md on every release
|
|
43
|
+
lists them with their licenses and reproduces ui/neuron-tui/LICENSE and NOTICE.
|
|
44
|
+
|
|
45
|
+
Bundled third-party skills
|
|
46
|
+
--------------------------
|
|
47
|
+
|
|
48
|
+
The native binary embeds instruction bundles ("skills") from the following
|
|
49
|
+
projects. Each is distributed under the MIT License. The pinned upstream commits
|
|
50
|
+
are recorded in rust/crates/runtime/bundled-skills/SOURCES.json, and the full
|
|
51
|
+
license texts are kept in rust/crates/runtime/bundled-skills/licenses/ and are
|
|
52
|
+
embedded in the binary next to the skills. Neuron adds host-adapter sections to
|
|
53
|
+
some of these skills; those additions are not part of the upstream projects.
|
|
54
|
+
|
|
55
|
+
ponytail https://github.com/DietrichGebert/ponytail
|
|
56
|
+
MIT License, Copyright (c) 2026 DietrichGebert
|
|
57
|
+
licenses/ponytail.txt
|
|
58
|
+
|
|
59
|
+
antislop https://github.com/miqdadbadjuber/anti-slop
|
|
60
|
+
MIT License, Copyright (c) 2026 Miqdad Badjuber (antislop)
|
|
61
|
+
licenses/antislop.txt
|
|
62
|
+
|
|
63
|
+
gstack https://github.com/garrytan/gstack
|
|
64
|
+
MIT License, Copyright (c) 2026 Garry Tan
|
|
65
|
+
licenses/gstack.txt
|
|
66
|
+
|
|
67
|
+
agent-reach https://github.com/Panniantong/Agent-Reach
|
|
68
|
+
MIT License, Copyright (c) 2025 Agent Eyes
|
|
69
|
+
licenses/agent-reach.txt
|
|
70
|
+
|
|
71
|
+
Rust crate dependencies
|
|
72
|
+
-----------------------
|
|
73
|
+
|
|
74
|
+
The native binary statically links Rust crates published on crates.io under
|
|
75
|
+
their own licenses (mostly MIT and/or Apache-2.0; also ISC, BSD, BSL-1.0, Zlib,
|
|
76
|
+
Unicode-3.0, CDLA-Permissive-2.0 and MPL-2.0). Every GitHub release attaches
|
|
77
|
+
THIRD_PARTY_NOTICES.md, which lists each crate, version, license and repository
|
|
78
|
+
and reproduces the license and notice files shipped with each crate. Generate it
|
|
79
|
+
locally with:
|
|
80
|
+
|
|
81
|
+
node scripts/generate-third-party-notices.mjs
|
|
82
|
+
|
|
83
|
+
npm package dependencies
|
|
84
|
+
------------------------
|
|
85
|
+
|
|
86
|
+
The npm package @zero-x.live/neuron installs, but does not bundle,
|
|
87
|
+
codebase-memory-mcp (MIT License) and @playwright/mcp (Apache License 2.0).
|
|
88
|
+
npm installs them with their own license files.
|
|
89
|
+
|
|
90
|
+
Trademarks and affiliation
|
|
91
|
+
--------------------------
|
|
92
|
+
|
|
93
|
+
Neuron and Zero-X are not affiliated with or endorsed by UltraWorkers, Anthropic,
|
|
94
|
+
OpenAI, Google, Groq, Cloudflare, NVIDIA, OpenRouter, or any other model
|
|
95
|
+
provider. Product and model names are trademarks of their respective owners and
|
|
96
|
+
are used only to identify compatible services.
|
|
@@ -0,0 +1,312 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: neuroncli
|
|
3
|
+
Version: 7.0.0a3
|
|
4
|
+
Summary: Neuron - terminal coding agent powered by the Zero-X gateway
|
|
5
|
+
Author: RAHUL S / Zero-X
|
|
6
|
+
License-Expression: MIT
|
|
7
|
+
Project-URL: Homepage, https://github.com/RAHUL-DevelopeRR/neuron-v2
|
|
8
|
+
Project-URL: Repository, https://github.com/RAHUL-DevelopeRR/neuron-v2
|
|
9
|
+
Project-URL: Issues, https://github.com/RAHUL-DevelopeRR/neuron-v2/issues
|
|
10
|
+
Project-URL: Pricing, https://zero-x.live/pricing
|
|
11
|
+
Keywords: ai,coding-agent,cli,terminal,neuron,zero-x
|
|
12
|
+
Classifier: Development Status :: 3 - Alpha
|
|
13
|
+
Classifier: Environment :: Console
|
|
14
|
+
Classifier: Intended Audience :: Developers
|
|
15
|
+
Classifier: Operating System :: MacOS
|
|
16
|
+
Classifier: Operating System :: Microsoft :: Windows
|
|
17
|
+
Classifier: Operating System :: POSIX :: Linux
|
|
18
|
+
Classifier: Programming Language :: Python :: 3
|
|
19
|
+
Classifier: Programming Language :: Rust
|
|
20
|
+
Classifier: Topic :: Software Development
|
|
21
|
+
Requires-Python: >=3.9
|
|
22
|
+
Description-Content-Type: text/markdown
|
|
23
|
+
License-File: LICENSE
|
|
24
|
+
License-File: NOTICE
|
|
25
|
+
Dynamic: license-file
|
|
26
|
+
|
|
27
|
+
# Neuron
|
|
28
|
+
|
|
29
|
+
Neuron by [Zero-X](https://zero-x.live/neuron-cli) is an open-source AI coding agent
|
|
30
|
+
that runs in your terminal. It reads your project, edits files and runs commands, and
|
|
31
|
+
asks before it does anything your permission mode does not allow. It is a single
|
|
32
|
+
native binary written in Rust. New to coding agents? Read
|
|
33
|
+
[how an AI coding agent works](https://zero-x.live/ai-coding-agent).
|
|
34
|
+
|
|
35
|
+
By default Neuron talks to models through the [Zero-X gateway](https://zero-x.live).
|
|
36
|
+
You sign in once with `neuron auth login`; the provider API keys stay on the gateway
|
|
37
|
+
and never reach your machine. You can also use your own provider key instead.
|
|
38
|
+
|
|
39
|
+
> 7.0.0-alpha.3 is Neuron's third alpha, built and published by this repository's
|
|
40
|
+
> release pipeline. Its known limitations are listed in
|
|
41
|
+
> the [changelog](https://github.com/RAHUL-DevelopeRR/neuron-v2/blob/HEAD/CHANGELOG.md).
|
|
42
|
+
> It is a GitHub prerelease, so the install scripts need the versioned commands below.
|
|
43
|
+
> The npm 6.2.0 and PyPI 6.2.4 (and earlier) packages were built outside the pipeline
|
|
44
|
+
> and are not supported.
|
|
45
|
+
|
|
46
|
+
## Install
|
|
47
|
+
|
|
48
|
+
Every method installs the same `neuron` binary from
|
|
49
|
+
[GitHub Releases](https://github.com/RAHUL-DevelopeRR/neuron-v2/releases) and checks
|
|
50
|
+
its SHA-256 checksum before using it.
|
|
51
|
+
|
|
52
|
+
A prerelease is never the "latest" GitHub release, so the install script commands below
|
|
53
|
+
name the alpha's version. Without one, the install scripts look up the latest release,
|
|
54
|
+
and there is none until the first stable release is out.
|
|
55
|
+
|
|
56
|
+
**macOS and Linux**
|
|
57
|
+
|
|
58
|
+
```sh
|
|
59
|
+
curl -fsSL https://github.com/RAHUL-DevelopeRR/neuron-v2/releases/download/v7.0.0-alpha.3/install.sh | sh -s -- --version 7.0.0-alpha.3
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
The script installs to `~/.local/bin` and tells you if that directory is not on your
|
|
63
|
+
`PATH`. Pass options after `sh -s --`, for example
|
|
64
|
+
`sh -s -- --version 7.0.0-alpha.3 --install-dir "$HOME/bin"`, or set `NEURON_VERSION`
|
|
65
|
+
and `NEURON_INSTALL_DIR`.
|
|
66
|
+
|
|
67
|
+
**Windows (PowerShell 5.1 or 7)**
|
|
68
|
+
|
|
69
|
+
```powershell
|
|
70
|
+
& ([scriptblock]::Create((irm https://github.com/RAHUL-DevelopeRR/neuron-v2/releases/download/v7.0.0-alpha.3/install.ps1))) -Version 7.0.0-alpha.3
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
The script installs to `%LOCALAPPDATA%\Programs\Neuron\bin` and only changes your
|
|
74
|
+
`PATH` if you ask it to:
|
|
75
|
+
|
|
76
|
+
```powershell
|
|
77
|
+
& ([scriptblock]::Create((irm https://github.com/RAHUL-DevelopeRR/neuron-v2/releases/download/v7.0.0-alpha.3/install.ps1))) -Version 7.0.0-alpha.3 -AddToPath
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
**npm** (Node.js 22.14 or later)
|
|
81
|
+
|
|
82
|
+
```sh
|
|
83
|
+
npm install --global @zero-x.live/neuron
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
**pip** (Python 3.9 or later). The alpha is a pre-release on PyPI, so pip needs
|
|
87
|
+
`--pre`:
|
|
88
|
+
|
|
89
|
+
```sh
|
|
90
|
+
pip install --pre neuroncli
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
The registry packages are published after the GitHub release, so check them first:
|
|
94
|
+
`npm view @zero-x.live/neuron version` should print `7.0.0-alpha.3`, and
|
|
95
|
+
`pip index versions neuroncli --pre` should list `7.0.0a3`. If they still show 6.2.0
|
|
96
|
+
(npm) or 6.2.4 (PyPI), those are old, unsupported builds: use the install scripts
|
|
97
|
+
above instead.
|
|
98
|
+
|
|
99
|
+
The npm and pip packages are small launchers that download the binaries for the
|
|
100
|
+
package's exact version and verify their checksums. npm downloads them during
|
|
101
|
+
`npm install`, without showing progress: `neuron` (about 17 MB) and `neuron-tui`
|
|
102
|
+
(about 110 MB) go into the package's `bin/native` folder. pip downloads them on first
|
|
103
|
+
use instead: `neuron` the first time you run it, and `neuron-tui` the first time the
|
|
104
|
+
full-screen UI opens; npm does the same when the network failed during the install.
|
|
105
|
+
pip keeps them in a per-version cache (`~/.cache/neuroncli` on Linux,
|
|
106
|
+
`~/Library/Caches/neuroncli` on macOS, `%LOCALAPPDATA%\neuroncli` on Windows). npm
|
|
107
|
+
uses a binary from that cache when its `bin/native` folder has none, and downloads into
|
|
108
|
+
the cache only when that folder is read-only. After that, Neuron starts without network
|
|
109
|
+
access. Ctrl+C goes to Neuron, and the launcher exits with Neuron's exit code.
|
|
110
|
+
|
|
111
|
+
With the installers or pip, the two default MCP servers (CodebaseMap, which `/mcp`
|
|
112
|
+
lists as `codebase-memory`, and Playwright) start through `npx -y`, so they need
|
|
113
|
+
Node.js; the npm package installs them with Neuron.
|
|
114
|
+
|
|
115
|
+
On a terminal, `neuron` with no prompt opens the full-screen UI, `neuron-tui`. The
|
|
116
|
+
installers put it beside `neuron`, and the launchers fetch it the same way, verified
|
|
117
|
+
by checksum. `neuron --no-tui` (or `NEURON_NO_TUI=1`) keeps the line REPL. Without
|
|
118
|
+
the UI, for example after a failed download, `neuron` runs the line REPL as
|
|
119
|
+
before. Prompts (`neuron "fix the test"`, `neuron -p ...`) and subcommands never
|
|
120
|
+
start it.
|
|
121
|
+
|
|
122
|
+
**From source**
|
|
123
|
+
|
|
124
|
+
```sh
|
|
125
|
+
git clone https://github.com/RAHUL-DevelopeRR/neuron-v2.git
|
|
126
|
+
cd neuron-v2/rust
|
|
127
|
+
cargo build --release -p rusty-claude-cli
|
|
128
|
+
./target/release/neuron --version
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
### Supported platforms
|
|
132
|
+
|
|
133
|
+
| Platform | Release assets |
|
|
134
|
+
| --- | --- |
|
|
135
|
+
| Linux x64, glibc 2.35 or later | `neuron-linux-x64`, `neuron-tui-linux-x64` |
|
|
136
|
+
| Linux arm64, glibc 2.35 or later | `neuron-linux-arm64`, `neuron-tui-linux-arm64` |
|
|
137
|
+
| macOS, Apple silicon | `neuron-macos-arm64`, `neuron-tui-macos-arm64` |
|
|
138
|
+
| macOS, Intel | `neuron-macos-x64`, `neuron-tui-macos-x64` |
|
|
139
|
+
| Windows x64 | `neuron-windows-x64.exe`, `neuron-tui-windows-x64.exe` (Windows on Arm runs them under emulation) |
|
|
140
|
+
|
|
141
|
+
glibc 2.35 or later means Ubuntu 22.04, Debian 12, Fedora 36 or newer. On older
|
|
142
|
+
distributions (for example Ubuntu 20.04, Debian 11 or RHEL 9) the binary may not
|
|
143
|
+
start; the installers check that before they install anything, and you can build
|
|
144
|
+
from source instead. musl-based Linux such as Alpine is not supported. The binaries are not code-signed or
|
|
145
|
+
notarized. Each release lists SHA-256 checksums (`SHA256SUMS`, plus a `.sha256` file
|
|
146
|
+
per binary) and GitHub build provenance, which you can check with
|
|
147
|
+
`gh attestation verify neuron-linux-x64 --repo RAHUL-DevelopeRR/neuron-v2`.
|
|
148
|
+
|
|
149
|
+
## Sign in
|
|
150
|
+
|
|
151
|
+
```sh
|
|
152
|
+
neuron login # shows a code; approve it on neuron.zero-x.live/device
|
|
153
|
+
neuron auth status
|
|
154
|
+
neuron logout # revokes the session on the gateway and deletes the local copy
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
Login prints a link and a short code and opens the link in your browser when it can.
|
|
158
|
+
Approve the code there (or on any other device, such as your phone) and Neuron
|
|
159
|
+
continues on its own; no local port is opened, so it also works over SSH. It stores the
|
|
160
|
+
session in the operating system's credential store on macOS and Windows. On Linux (or
|
|
161
|
+
when that store is unavailable) it goes to `~/.neuroncli/credentials.json`, readable
|
|
162
|
+
only by you; protect that directory like a password file. The
|
|
163
|
+
[security policy](https://github.com/RAHUL-DevelopeRR/neuron-v2/blob/HEAD/SECURITY.md#how-neuron-handles-credentials)
|
|
164
|
+
explains what to do if it leaks. On CI and machines without a browser,
|
|
165
|
+
create a personal API key (`nzx_…`) in the Zero-X dashboard and pass it with
|
|
166
|
+
`neuron auth login --with-token` or the `NEURON_TOKEN` environment variable. See
|
|
167
|
+
[Sign in](https://github.com/RAHUL-DevelopeRR/neuron-v2/blob/HEAD/USAGE.md#sign-in)
|
|
168
|
+
in the usage guide.
|
|
169
|
+
|
|
170
|
+
## Plans and limits
|
|
171
|
+
|
|
172
|
+
**Free.** No card needed. Free-plan requests run on free tiers of upstream providers:
|
|
173
|
+
Groq, the Gemini API free tier, Cloudflare Workers AI, NVIDIA's API catalog and
|
|
174
|
+
OpenRouter's free models. The limits are real and you will run into them:
|
|
175
|
+
|
|
176
|
+
| Free plan | Limit |
|
|
177
|
+
| --- | --- |
|
|
178
|
+
| Requests per day | 100 |
|
|
179
|
+
| Tokens per day | 500,000 |
|
|
180
|
+
| Requests per minute | 10 |
|
|
181
|
+
| Concurrent requests | 2 |
|
|
182
|
+
|
|
183
|
+
- Everyone on the free plan shares the same upstream capacity. When a shared pool
|
|
184
|
+
runs out, requests fail with `capacity_exhausted` and a time to retry.
|
|
185
|
+
- Some free models have small per-minute token budgets, so a long prompt may fit on
|
|
186
|
+
only some models, or on none.
|
|
187
|
+
- The Gemini free tier is not offered to callers in the EEA, the UK or Switzerland.
|
|
188
|
+
- Which models are free depends on what the providers offer, and can change at any
|
|
189
|
+
time. `/model` lists what is available to you now; outside a session,
|
|
190
|
+
`curl https://zero-x.live/v1/models` shows the current catalog.
|
|
191
|
+
|
|
192
|
+
**Pro and Max.** Paid plans raise the daily and per-minute limits and add paid
|
|
193
|
+
upstream capacity, billed against monthly credits included with the plan; credit
|
|
194
|
+
top-ups are also sold. Prices and current limits are at
|
|
195
|
+
<https://zero-x.live/pricing>. In Neuron, `/upgrade` opens that page, and
|
|
196
|
+
`neuron usage` (or `/usage`) shows your plan, today's usage and your credit balance.
|
|
197
|
+
|
|
198
|
+
## Bring your own key
|
|
199
|
+
|
|
200
|
+
You can bypass the gateway with a provider account of your own: for example
|
|
201
|
+
`OPENAI_API_KEY` (plus `OPENAI_BASE_URL` for any OpenAI-compatible endpoint, including
|
|
202
|
+
a local model server), `ANTHROPIC_API_KEY`, `XAI_API_KEY`, Azure AI Foundry or
|
|
203
|
+
`OPENROUTER_API_KEY`. The gateway offers two of OpenRouter's free models; your own key
|
|
204
|
+
gives you the rest of OpenRouter. While you are signed in to Zero-X the gateway stays
|
|
205
|
+
the default; a provider key is used when you select that provider (`--provider`,
|
|
206
|
+
`NEURON_PROVIDER` or the `provider` setting) or when you are not signed in. Neuron
|
|
207
|
+
prints which provider and credential it uses when it starts. See
|
|
208
|
+
[Bring your own key](https://github.com/RAHUL-DevelopeRR/neuron-v2/blob/HEAD/USAGE.md#bring-your-own-key).
|
|
209
|
+
|
|
210
|
+
## Privacy
|
|
211
|
+
|
|
212
|
+
What you send in a session (prompts, the contents of files Neuron reads, command
|
|
213
|
+
output) is processed by third-party model providers: the upstream provider the
|
|
214
|
+
gateway routes to (Groq, Google, Cloudflare, NVIDIA, OpenRouter or a paid upstream),
|
|
215
|
+
or the provider whose key you configured. Their terms apply. Free tiers can have
|
|
216
|
+
different data-use terms from paid ones; Google, for example, may use Gemini API
|
|
217
|
+
free-tier content to improve its products. Paid Zero-X plans also use the free pools
|
|
218
|
+
first and fall back to paid capacity, so if your code must stay under one provider's
|
|
219
|
+
terms, use your own key for that provider.
|
|
220
|
+
|
|
221
|
+
The gateway forwards each request to the upstream provider and records usage metadata
|
|
222
|
+
(model, token counts, latency, status) for quotas and billing. Neuron sends no
|
|
223
|
+
analytics of its own. Tools you allow, such as shell commands, web fetches and MCP
|
|
224
|
+
servers, can contact other services.
|
|
225
|
+
|
|
226
|
+
## Using Neuron
|
|
227
|
+
|
|
228
|
+
```sh
|
|
229
|
+
cd your-project
|
|
230
|
+
neuron # interactive session
|
|
231
|
+
neuron prompt "explain src/main.rs" # one prompt, then exit
|
|
232
|
+
neuron --resume latest prompt "and the tests?" # one more prompt in the newest session
|
|
233
|
+
neuron --permission-mode read-only # read and search only
|
|
234
|
+
```
|
|
235
|
+
|
|
236
|
+
Neuron asks you to trust a directory before working in it. The default permission
|
|
237
|
+
mode, `workspace-write`, lets it read and edit files in the workspace and run shell
|
|
238
|
+
commands that only read; it asks before any other command, before fetching from a new
|
|
239
|
+
web domain and before other tools that need full access. The
|
|
240
|
+
[usage guide](https://github.com/RAHUL-DevelopeRR/neuron-v2/blob/HEAD/USAGE.md) covers
|
|
241
|
+
commands, slash commands, permission modes, models, sessions and configuration.
|
|
242
|
+
|
|
243
|
+
### Scripts and CI
|
|
244
|
+
|
|
245
|
+
```sh
|
|
246
|
+
neuron --output-format json prompt "run the tests and summarise the failures"
|
|
247
|
+
neuron --resume latest prompt "now fix the first failure"
|
|
248
|
+
```
|
|
249
|
+
|
|
250
|
+
Launch flags go before `prompt` (or `-p`). Everything after `-p` is the prompt, so a
|
|
251
|
+
flag such as `--output-format` there is refused rather than sent to the model. Without
|
|
252
|
+
a terminal on standard input nobody can approve a tool call, so a call that would ask
|
|
253
|
+
is denied instead, the model is told it did not run, and Neuron exits with code 2 after
|
|
254
|
+
the answer. Each denial names the `permissions.allow` rules that would let that call
|
|
255
|
+
run, when any would, and the last warning lists them all.
|
|
256
|
+
|
|
257
|
+
Allow what your script needs in your user settings, `~/.neuron/settings.json`. A
|
|
258
|
+
script never gets the trust question, so the workspace's own settings, allow rules
|
|
259
|
+
included, are ignored until you
|
|
260
|
+
[trust it](https://github.com/RAHUL-DevelopeRR/neuron-v2/blob/HEAD/USAGE.md#workspace-trust).
|
|
261
|
+
|
|
262
|
+
```json
|
|
263
|
+
{
|
|
264
|
+
"permissions": {
|
|
265
|
+
"defaultMode": "workspace-write",
|
|
266
|
+
"allow": ["bash(npm:*)", "PowerShell(npm:*)"]
|
|
267
|
+
}
|
|
268
|
+
}
|
|
269
|
+
```
|
|
270
|
+
|
|
271
|
+
`bash(npm:*)` lets a shell command run when every part of it that needs approval is
|
|
272
|
+
an `npm` command (`npm install && npm run build`). Rules count together: with
|
|
273
|
+
`bash(cargo:*)` as well, `cargo test && npm run build` runs too. No prefix rule covers
|
|
274
|
+
a command that writes a file through a redirection (`npm test > out.txt`), sets an
|
|
275
|
+
environment variable first (`CI=true npm test`) or uses a substitution; a rule for the
|
|
276
|
+
exact command does (`"bash(npm test > out.txt)"`). `"WebSearch"` allows web searches.
|
|
277
|
+
Use `--permission-mode danger-full-access` only in a disposable environment such as a
|
|
278
|
+
container: it lets every tool call run.
|
|
279
|
+
|
|
280
|
+
Each `neuron prompt` run starts a new session; `neuron --resume latest prompt "..."`
|
|
281
|
+
sends the newest session another prompt. The JSON answer's `session_id` is what
|
|
282
|
+
`--resume` takes, so a script can continue its own session by id. One run at a time can
|
|
283
|
+
continue a session: a second one is refused as "in use" rather than overwriting the
|
|
284
|
+
first one's turns.
|
|
285
|
+
|
|
286
|
+
## Documentation
|
|
287
|
+
|
|
288
|
+
- [Usage guide](https://github.com/RAHUL-DevelopeRR/neuron-v2/blob/HEAD/USAGE.md)
|
|
289
|
+
- [Default skills and integrations](https://github.com/RAHUL-DevelopeRR/neuron-v2/blob/HEAD/docs/DEFAULT_INTEGRATIONS.md)
|
|
290
|
+
(bundled skills are listed in the system prompt and loaded on demand)
|
|
291
|
+
- [Security policy](https://github.com/RAHUL-DevelopeRR/neuron-v2/blob/HEAD/SECURITY.md)
|
|
292
|
+
- [Contributing](https://github.com/RAHUL-DevelopeRR/neuron-v2/blob/HEAD/CONTRIBUTING.md)
|
|
293
|
+
- [Release runbook](https://github.com/RAHUL-DevelopeRR/neuron-v2/blob/HEAD/PUBLISHING.md)
|
|
294
|
+
- [Changelog](https://github.com/RAHUL-DevelopeRR/neuron-v2/blob/HEAD/CHANGELOG.md)
|
|
295
|
+
- [Neuron and Zero-X platform contract](https://github.com/RAHUL-DevelopeRR/neuron-v2/blob/HEAD/docs/GATEWAY_CONTRACT.md)
|
|
296
|
+
- [Code provenance](https://github.com/RAHUL-DevelopeRR/neuron-v2/blob/HEAD/docs/PROVENANCE.md)
|
|
297
|
+
|
|
298
|
+
The parity, roadmap and architecture documents describe the upstream project Neuron
|
|
299
|
+
grew out of and may still use its `claw` command names.
|
|
300
|
+
|
|
301
|
+
## License
|
|
302
|
+
|
|
303
|
+
MIT; see [LICENSE](https://github.com/RAHUL-DevelopeRR/neuron-v2/blob/HEAD/LICENSE).
|
|
304
|
+
Neuron is derived from [Claw Code](https://github.com/ultraworkers/claw-code), also
|
|
305
|
+
MIT. The full-screen UI (`ui/neuron-tui`, the `neuron-tui` binaries) is derived from
|
|
306
|
+
[Freebuff](https://github.com/CodebuffAI/freebuff) and is under the Apache License 2.0.
|
|
307
|
+
[NOTICE](https://github.com/RAHUL-DevelopeRR/neuron-v2/blob/HEAD/NOTICE) records both
|
|
308
|
+
lineages and the bundled third-party skills, and every release attaches
|
|
309
|
+
`THIRD_PARTY_NOTICES.md` with the licenses of the Rust crates compiled into `neuron`
|
|
310
|
+
and of the Bun runtime and npm packages compiled into `neuron-tui`.
|
|
311
|
+
Neuron and Zero-X are not affiliated with Anthropic, OpenAI, Google, Groq, Cloudflare
|
|
312
|
+
or any other model provider.
|