grok-agent 0.5.0 → 0.5.1
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 +35 -11
- package/dist/config.d.ts +1 -1
- package/dist/config.js +1 -1
- package/dist/config.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,5 +1,8 @@
|
|
|
1
1
|
# grok-agent
|
|
2
2
|
|
|
3
|
+
[](https://www.npmjs.com/package/grok-agent)
|
|
4
|
+
[](https://github.com/baba20o/grok-cli/blob/main/LICENSE)
|
|
5
|
+
|
|
3
6
|
A coding assistant CLI powered by xAI's Grok models.
|
|
4
7
|
|
|
5
8
|
`grok-agent` gives you an agentic assistant in your terminal that can chat, inspect and edit code, run shell commands, search a repo, attach files/images, use xAI server-side tools, and keep JSONL-backed session history.
|
|
@@ -24,27 +27,47 @@ A coding assistant CLI powered by xAI's Grok models.
|
|
|
24
27
|
- Structured JSON output with `--json-schema`
|
|
25
28
|
- Token usage display, citations, approvals, hooks, and notifications
|
|
26
29
|
|
|
27
|
-
##
|
|
30
|
+
## Install
|
|
28
31
|
|
|
29
32
|
```bash
|
|
30
|
-
|
|
33
|
+
npm install -g grok-agent
|
|
34
|
+
```
|
|
31
35
|
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
npm run build
|
|
36
|
-
npm link
|
|
36
|
+
Requires Node.js >= 20 and an [xAI API key](https://console.x.ai/team/default/api-keys).
|
|
37
|
+
|
|
38
|
+
Set your API key:
|
|
37
39
|
|
|
40
|
+
```bash
|
|
41
|
+
# Option 1: environment variable
|
|
38
42
|
export XAI_API_KEY=your_key_here
|
|
43
|
+
|
|
44
|
+
# Option 2: .env file (in your project root or ~/.grok-cli/.env)
|
|
45
|
+
echo "XAI_API_KEY=your_key_here" > .env
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
Verify everything works:
|
|
49
|
+
|
|
50
|
+
```bash
|
|
39
51
|
grok-agent doctor
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
Start using it:
|
|
55
|
+
|
|
56
|
+
```bash
|
|
40
57
|
grok-agent "what does this project do?"
|
|
41
58
|
```
|
|
42
59
|
|
|
43
|
-
|
|
60
|
+
### Install from source
|
|
61
|
+
|
|
62
|
+
```bash
|
|
63
|
+
git clone https://github.com/baba20o/grok-cli.git
|
|
64
|
+
cd grok-cli
|
|
65
|
+
npm install
|
|
66
|
+
npm run build
|
|
67
|
+
npm link
|
|
68
|
+
```
|
|
44
69
|
|
|
45
|
-
|
|
46
|
-
- the parent directory
|
|
47
|
-
- `~/.grok-agent/.env`
|
|
70
|
+
The CLI loads `.env` from the current directory, the parent directory, or `~/.grok-cli/.env`.
|
|
48
71
|
|
|
49
72
|
## Usage
|
|
50
73
|
|
|
@@ -164,6 +187,7 @@ Current built-in aliases:
|
|
|
164
187
|
|
|
165
188
|
| Flag | Model |
|
|
166
189
|
|---|---|
|
|
190
|
+
| *(default)* | `grok-4.20-0309-reasoning` |
|
|
167
191
|
| `--fast` | `grok-4-1-fast-reasoning` |
|
|
168
192
|
| `--reasoning` | `grok-4.20-0309-reasoning` |
|
|
169
193
|
| `--non-reasoning` | `grok-4.20-0309-non-reasoning` |
|
package/dist/config.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { GrokConfig } from "./types.js";
|
|
2
2
|
declare const MODELS: {
|
|
3
|
-
readonly default: "grok-4-
|
|
3
|
+
readonly default: "grok-4.20-0309-reasoning";
|
|
4
4
|
readonly fast: "grok-4-1-fast-reasoning";
|
|
5
5
|
readonly reasoning: "grok-4.20-0309-reasoning";
|
|
6
6
|
readonly nonReasoning: "grok-4.20-0309-non-reasoning";
|
package/dist/config.js
CHANGED
|
@@ -15,7 +15,7 @@ for (const p of envPaths) {
|
|
|
15
15
|
}
|
|
16
16
|
}
|
|
17
17
|
const MODELS = {
|
|
18
|
-
default: "grok-4-
|
|
18
|
+
default: "grok-4.20-0309-reasoning",
|
|
19
19
|
fast: "grok-4-1-fast-reasoning",
|
|
20
20
|
reasoning: "grok-4.20-0309-reasoning",
|
|
21
21
|
nonReasoning: "grok-4.20-0309-non-reasoning",
|
package/dist/config.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,OAAO,EAAE,MAAM,QAAQ,CAAC;AAC3C,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AAUzD,MAAM,QAAQ,GAAG;IACf,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,MAAM,CAAC;IAChC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,MAAM,CAAC;IACtC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,EAAE,WAAW,EAAE,MAAM,CAAC;CAC7C,CAAC;AACF,KAAK,MAAM,CAAC,IAAI,QAAQ,EAAE,CAAC;IACzB,IAAI,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;QACrB,OAAO,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC;QACrB,MAAM;IACR,CAAC;AACH,CAAC;AAED,MAAM,MAAM,GAAG;IACb,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,OAAO,EAAE,MAAM,QAAQ,CAAC;AAC3C,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AAUzD,MAAM,QAAQ,GAAG;IACf,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,MAAM,CAAC;IAChC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,MAAM,CAAC;IACtC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,EAAE,WAAW,EAAE,MAAM,CAAC;CAC7C,CAAC;AACF,KAAK,MAAM,CAAC,IAAI,QAAQ,EAAE,CAAC;IACzB,IAAI,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;QACrB,OAAO,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC;QACrB,MAAM;IACR,CAAC;AACH,CAAC;AAED,MAAM,MAAM,GAAG;IACb,OAAO,EAAE,0BAA0B;IACnC,IAAI,EAAE,yBAAyB;IAC/B,SAAS,EAAE,0BAA0B;IACrC,YAAY,EAAE,8BAA8B;IAC5C,UAAU,EAAE,4BAA4B;IACxC,IAAI,EAAE,kBAAkB;CAChB,CAAC;AAEX,SAAS,UAAU;IACjB,OAAO,OAAO,CAAC,GAAG,CAAC,gBAAgB,IAAI,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,EAAE,WAAW,CAAC,CAAC;AAC9E,CAAC;AAED,SAAS,oBAAoB;IAC3B,OAAO,OAAO,CAAC,GAAG,CAAC,uBAAuB,IAAI,gCAAgC,CAAC;AACjF,CAAC;AAED,SAAS,cAAc;IACrB,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,aAAa,CAAC,CAAC;IAC1D,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC;QAAE,OAAO,EAAE,CAAC;IAC1C,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;IAC1D,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,CAAC;IACZ,CAAC;AACH,CAAC;AAED,SAAS,mBAAmB,CAAC,KAA4C;IACvE,IAAI,CAAC,KAAK;QAAE,OAAO,EAAE,CAAC;IACtB,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;YAC5B,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,GAAG,EAAE,MAAM,CAAC,GAAG;YACf,WAAW,EAAE,MAAM,CAAC,WAAW;YAC/B,YAAY,EAAE,MAAM,CAAC,YAAY,IAAI,EAAE;SACxC,CAAC,CAAC,CAAC;IACN,CAAC;IACD,OAAO,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;AACvE,CAAC;AAED,SAAS,eAAe,CAAC,OAAoB,EAAE,SAAsB;IACnE,MAAM,MAAM,GAAG,CAAC,GAAG,OAAO,CAAC,CAAC;IAC5B,KAAK,MAAM,MAAM,IAAI,SAAS,EAAE,CAAC;QAC/B,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,KAAK,MAAM,CAAC,KAAK,IAAI,KAAK,CAAC,GAAG,KAAK,MAAM,CAAC,GAAG,CAAC,CAAC;QAClG,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,MAAM,CAAC,IAAI,CAAC,EAAE,GAAG,MAAM,EAAE,YAAY,EAAE,MAAM,CAAC,YAAY,IAAI,EAAE,EAAE,CAAC,CAAC;YACpE,SAAS;QACX,CAAC;QACD,QAAQ,CAAC,WAAW,GAAG,QAAQ,CAAC,WAAW,IAAI,MAAM,CAAC,WAAW,CAAC;QAClE,QAAQ,CAAC,YAAY,GAAG;YACtB,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,YAAY,IAAI,EAAE,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,YAAY,IAAI,EAAE,CAAC,CAAC,CAAC;SAC/E,CAAC;IACJ,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,YAAiC,EAAE;IAC3D,MAAM,UAAU,GAAG,cAAc,EAAE,CAAC;IACpC,MAAM,UAAU,GAAG,SAAS,CAAC,UAAU,IAAI,KAAK,CAAC;IACjD,MAAM,MAAM,GAAG,SAAS,CAAC,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC,WAAW,IAAI,OAAO,CAAC,GAAG,CAAC,WAAW,IAAI,EAAE,CAAC;IAC5F,MAAM,gBAAgB,GACpB,SAAS,CAAC,gBAAgB;QAC1B,UAAU,CAAC,kBAAkB;QAC7B,OAAO,CAAC,GAAG,CAAC,sBAAsB;QAClC,OAAO,CAAC,GAAG,CAAC,uBAAuB;QACnC,EAAE,CAAC;IAEL,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,CAAC,KAAK,CACX,+BAA+B;YAC/B,yDAAyD;YACzD,wCAAwC,CACzC,CAAC;QACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,MAAM,cAAc,GAAG,mBAAmB,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;IACnE,MAAM,UAAU,GAAG,eAAe,CAAC,cAAc,EAAE,SAAS,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC;IAE/E,MAAM,eAAe,GAAG,oBAAoB,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;IACtE,MAAM,mBAAmB,GAAG,oBAAoB,CAC9C,SAAS,CAAC,WAAmE,CAC9E,CAAC;IACF,MAAM,WAAW,GAAG,oBAAoB,CAAC,CAAC,GAAG,eAAe,EAAE,GAAG,mBAAmB,CAAC,CAAC,CAAC;IAEvF,MAAM,iBAAiB,GACrB,SAAS,CAAC,eAAe;QACzB,WAAW,CAAC,MAAM,GAAG,CAAC;QACtB,UAAU,CAAC,MAAM,GAAG,CAAC;QACrB,CAAC,SAAS,CAAC,eAAe,IAAI,SAAS,CAAC,eAAe,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAEtE,MAAM,WAAW,GACf,SAAS,CAAC,WAAW;QACrB,UAAU,CAAC,YAAY;QACtB,OAAO,CAAC,GAAG,CAAC,iBAA6C;QAC1D,oBAAoB,CAAC;IAEvB,OAAO;QACL,MAAM;QACN,gBAAgB;QAChB,OAAO,EAAE,SAAS,CAAC,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,YAAY,IAAI,qBAAqB;QAC/E,iBAAiB,EACf,SAAS,CAAC,iBAAiB,IAAI,UAAU,CAAC,mBAAmB,IAAI,oBAAoB,EAAE;QACzF,KAAK,EAAE,SAAS,CAAC,KAAK,IAAI,UAAU,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,UAAU,IAAI,MAAM,CAAC,OAAO;QACtF,SAAS,EAAE,SAAS,CAAC,SAAS,IAAI,KAAK;QACvC,OAAO,EAAE,SAAS,CAAC,OAAO,IAAI,OAAO;QACrC,eAAe,EAAE,SAAS,CAAC,eAAe,IAAI,MAAM;QACpD,aAAa,EAAE,SAAS,CAAC,aAAa,IAAI,UAAU,CAAC,cAAc,IAAI,KAAK;QAC5E,aAAa,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,aAAa,IAAI,IAAI,CAAC;QACrE,SAAS,EAAE,SAAS,CAAC,SAAS,IAAI,UAAU,CAAC,UAAU,IAAI,KAAK;QAChE,aAAa,EAAE,SAAS,CAAC,aAAa,IAAI,UAAU,CAAC,cAAc,IAAI,IAAI;QAC3E,SAAS,EAAE,SAAS,CAAC,SAAS,IAAI,UAAU,CAAC,UAAU,IAAI,IAAI;QAC/D,mBAAmB,EACjB,SAAS,CAAC,mBAAmB,IAAI,UAAU,CAAC,sBAAsB,IAAI,KAAK;QAC7E,aAAa,EAAE,SAAS,CAAC,aAAa,IAAI,UAAU,CAAC,SAAS,IAAI,EAAE;QACpE,WAAW;QACX,eAAe,EAAE,CAAC,CAAC,iBAAiB;QACpC,UAAU,EAAE,UAAU,EAAE;QACxB,UAAU;QACV,WAAW,EAAE,SAAS,CAAC,WAAW,IAAI,EAAE;QACxC,eAAe,EAAE,SAAS,CAAC,eAAe,IAAI,EAAE;QAChD,UAAU,EAAE,SAAS,CAAC,UAAU,IAAI,IAAI;QACxC,cAAc,EAAE,SAAS,CAAC,cAAc,IAAI,UAAU,CAAC,eAAe,IAAI,gBAAgB;QAC1F,WAAW;QACX,aAAa,EAAE;YACb,WAAW,EAAE,SAAS,CAAC,aAAa,EAAE,WAAW,IAAI,UAAU,CAAC,cAAc,EAAE,WAAW;YAC3F,KAAK,EAAE;gBACL,GAAG,CAAC,UAAU,CAAC,cAAc,EAAE,KAAK,IAAI,EAAE,CAAC;gBAC3C,GAAG,CAAC,SAAS,CAAC,aAAa,EAAE,KAAK,IAAI,EAAE,CAAC;aAC1C;SACF;QACD,kBAAkB,EAChB,SAAS,CAAC,kBAAkB,IAAI,UAAU,CAAC,oBAAoB,IAAI,KAAK;QAC1E,MAAM,EAAE,SAAS,CAAC,MAAM,IAAI,UAAU,CAAC,MAAM,IAAI,KAAK;QACtD,KAAK,EAAE,SAAS,CAAC,KAAK,IAAI,UAAU,CAAC,KAAK,IAAI,EAAE;QAChD,MAAM,EAAE,SAAS,CAAC,MAAM,IAAI,IAAI;QAChC,UAAU;QACV,SAAS,EAAE,SAAS,CAAC,SAAS,IAAI,KAAK;QACvC,UAAU,EAAE,SAAS,CAAC,UAAU,IAAI,IAAI;QACxC,KAAK,EAAE,SAAS,CAAC,KAAK,IAAI,MAAM;QAChC,eAAe,EAAE,SAAS,CAAC,eAAe,IAAI,IAAI;KACnD,CAAC;AACJ,CAAC;AAED,OAAO,EAAE,MAAM,EAAE,CAAC"}
|