agent-gauntlet 0.1.4 → 0.1.5
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 +26 -10
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -18,34 +18,50 @@ Agent Gauntlet is designed to be "tool-agnostic" by leveraging the AI CLI tools
|
|
|
18
18
|
|
|
19
19
|
### Requirements
|
|
20
20
|
|
|
21
|
-
- **Bun**
|
|
21
|
+
- **Bun** or **Node.js** (runtime)
|
|
22
22
|
- **git** (change detection and diffs)
|
|
23
|
-
- For review gates: one or more supported AI CLIs installed (`gemini`, `codex`, `claude`). For the full list of tools and how they are used, see [CLI Invocation Details](
|
|
23
|
+
- For review gates: one or more supported AI CLIs installed (`gemini`, `codex`, `claude`). For the full list of tools and how they are used, see [CLI Invocation Details](docs/cli-invocation-details.md)
|
|
24
24
|
|
|
25
|
-
###
|
|
25
|
+
### Installation
|
|
26
26
|
|
|
27
|
-
-
|
|
27
|
+
You can install `agent-gauntlet` globally using `npm` or `bun`:
|
|
28
28
|
|
|
29
|
+
**Using npm:**
|
|
29
30
|
```bash
|
|
30
|
-
|
|
31
|
+
npm install -g agent-gauntlet
|
|
31
32
|
```
|
|
32
33
|
|
|
33
|
-
|
|
34
|
-
|
|
34
|
+
**Using Bun (Recommended):**
|
|
35
35
|
```bash
|
|
36
|
-
bun
|
|
36
|
+
bun add -g agent-gauntlet
|
|
37
37
|
```
|
|
38
38
|
|
|
39
|
+
### Quick start
|
|
40
|
+
|
|
39
41
|
- **Initialize configuration**
|
|
40
42
|
|
|
41
43
|
```bash
|
|
42
|
-
|
|
44
|
+
agent-gauntlet init
|
|
43
45
|
```
|
|
44
46
|
|
|
45
47
|
- **Run gates**
|
|
46
48
|
|
|
47
49
|
```bash
|
|
48
|
-
|
|
50
|
+
agent-gauntlet
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
### Development
|
|
54
|
+
|
|
55
|
+
- **Install dependencies**
|
|
56
|
+
|
|
57
|
+
```bash
|
|
58
|
+
bun install
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
- **Build the CLI binary**
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
bun run build
|
|
49
65
|
```
|
|
50
66
|
|
|
51
67
|
### Basic usage
|