nexrall-code 0.5.136 → 0.5.137
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/README.md +76 -0
- package/dist/index.js +2290 -1824
- package/package.json +4 -1
package/README.md
ADDED
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
# Nexrall Code CLI
|
|
2
|
+
|
|
3
|
+
**Nexrall Code in your terminal** - an autonomous coding agent for scripts, CI, and terminal-first workflows. The same agent engine as the [VS Code extension](https://marketplace.visualstudio.com/items?itemName=NexrallCode.nexrall-code-vscode), powered by [Nexrall](https://nexrall.com).
|
|
4
|
+
|
|
5
|
+
```bash
|
|
6
|
+
npm install -g nexrall-code
|
|
7
|
+
nex
|
|
8
|
+
```
|
|
9
|
+
|
|
10
|
+
Requires Node.js 20+ and a Nexrall account. It signs in with the same account as the extension; billing stays in one place and there are no API keys to configure.
|
|
11
|
+
|
|
12
|
+
## Quick start
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
nex # interactive session (starts in auto mode)
|
|
16
|
+
nex "fix the failing tests" # one-shot prompt, then exit
|
|
17
|
+
nex -c # continue the latest conversation in this folder
|
|
18
|
+
nex -r # resume a session picked from a list
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
On start, `nex` asks you to trust the folder before it reads project config (`.nexrall/mcp.json`, `nexrall.md`, skills, permissions). It asks every session on purpose, so a freshly pulled config can never run unannounced. Non-interactive runs can pre-authorise with `NEXRALL_TRUST_WORKSPACE=1`.
|
|
22
|
+
|
|
23
|
+
Inside an interactive session:
|
|
24
|
+
|
|
25
|
+
- type `/` for commands, `@` for file references
|
|
26
|
+
- Alt+M picks the model, Alt+T the thinking effort (or start with `-m` / `-e`)
|
|
27
|
+
- Shift+Tab (or `/mode`) switches ask / edit / auto / plan
|
|
28
|
+
- Esc stops the current turn; Ctrl+Up/Down (or `/find`) browses the conversation
|
|
29
|
+
- long tool output folds to an 8-line preview; Ctrl+O (or `/expand`) shows the rest
|
|
30
|
+
|
|
31
|
+
## Scripting and CI
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
nex --output-format json "summarise the failing tests" > result.json
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
- `--output-format text|json|stream-json` - machine-readable one-shot output (implies auto-approve)
|
|
38
|
+
- `--no-banner`, `--no-color` (or `NO_COLOR`) - clean output for pipes
|
|
39
|
+
- `--plan` / `--readonly` - start in plan mode; read-only is a lock that cannot be switched off
|
|
40
|
+
- `--audit [path]` - append every tool call (and refusal) to a local JSONL trail
|
|
41
|
+
- `-w, --worktree [name]` - run the session in its own git worktree
|
|
42
|
+
|
|
43
|
+
## Commands
|
|
44
|
+
|
|
45
|
+
| Command | What it does |
|
|
46
|
+
|---|---|
|
|
47
|
+
| `nex auth` | Log in to your Nexrall account |
|
|
48
|
+
| `nex logout` | Log out |
|
|
49
|
+
| `nex doctor` | Check Node, sign-in, network, terminal, MCP and storage, with a fix for each problem |
|
|
50
|
+
| `nex billing` | Show, or change, which budget pays for your usage |
|
|
51
|
+
| `nex sessions` | List or delete saved chat sessions |
|
|
52
|
+
| `nex plugin` | Manage plugins: install from GitHub, list, update, remove |
|
|
53
|
+
| `nex update` | Update `nex` to the latest version |
|
|
54
|
+
|
|
55
|
+
Official plugins live in [Maxrall-Inc/plugins](https://github.com/Maxrall-Inc/plugins).
|
|
56
|
+
|
|
57
|
+
## Selected flags
|
|
58
|
+
|
|
59
|
+
| Flag | What it does |
|
|
60
|
+
|---|---|
|
|
61
|
+
| `-m, --model <name>` | Explicit model, e.g. `claude-opus-5-5` or `gpt-5.4` |
|
|
62
|
+
| `-e, --effort <level>` | Thinking effort; the real levels depend on the model |
|
|
63
|
+
| `-d, --dir <path>` | Working directory |
|
|
64
|
+
| `--mode <mode>` | Starting permission mode: ask, edit, auto or plan |
|
|
65
|
+
| `-y, --yolo` | Auto-approve all tool calls (no permission prompts) |
|
|
66
|
+
| `--debug` | Write request timing, retries and errors to a debug log |
|
|
67
|
+
|
|
68
|
+
Run `nex --help` for the full list.
|
|
69
|
+
|
|
70
|
+
## Issues
|
|
71
|
+
|
|
72
|
+
Bug reports and feature requests: **[github.com/Maxrall-Inc/nexrall-code-issues](https://github.com/Maxrall-Inc/nexrall-code-issues/issues)**.
|
|
73
|
+
|
|
74
|
+
## License
|
|
75
|
+
|
|
76
|
+
MIT
|