farai 0.1.0 → 0.1.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 +2 -81
- package/dist/cli/index.js +16171 -5905
- package/dist/cli/index.js.map +234 -0
- package/package.json +7 -5
package/README.md
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
Cyber-first local AI agent for terminal-driven security work.
|
|
6
6
|
|
|
7
7
|
<p>
|
|
8
|
-
<a href="https://www.npmjs.com/package/farai"><img src="https://img.shields.io/npm/v/farai?style=flat&logo=npm" alt="npm"></a>
|
|
8
|
+
<a href="https://www.npmjs.com/package/farai"><img src="https://img.shields.io/npm/v/farai?style=flat&logo=npm&color=CB3837" alt="npm version"></a>
|
|
9
9
|
<a href="LICENSE"><img src="https://img.shields.io/badge/license-Apache--2.0-blue.svg" alt="License: Apache-2.0"></a>
|
|
10
10
|
<a href="https://github.com/pajarori/farai/stargazers"><img src="https://img.shields.io/github/stars/pajarori/farai?style=flat&logo=github" alt="GitHub stars"></a>
|
|
11
11
|
<a href="https://github.com/pajarori/farai/network/members"><img src="https://img.shields.io/github/forks/pajarori/farai?style=flat&logo=github" alt="GitHub forks"></a>
|
|
@@ -23,24 +23,13 @@ For CSI/CyBench materials and exploratory benchmark artifacts, see [farai-csi-be
|
|
|
23
23
|
|
|
24
24
|
## Installation
|
|
25
25
|
|
|
26
|
-
```bash
|
|
27
|
-
npm install -g farai
|
|
28
|
-
farai setup
|
|
29
|
-
farai
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
Or with Bun:
|
|
33
|
-
|
|
34
26
|
```bash
|
|
35
27
|
bun install -g farai
|
|
36
|
-
farai setup
|
|
37
|
-
farai
|
|
38
28
|
```
|
|
39
29
|
|
|
40
30
|
Requirements:
|
|
41
31
|
|
|
42
32
|
- Bun 1.1+
|
|
43
|
-
- Node.js 20+
|
|
44
33
|
- Docker
|
|
45
34
|
- A model provider/API key, unless using an already configured default provider
|
|
46
35
|
|
|
@@ -52,82 +41,14 @@ Configure Farai and prepare the local runtime:
|
|
|
52
41
|
farai setup
|
|
53
42
|
```
|
|
54
43
|
|
|
55
|
-
Configure a model provider during setup:
|
|
56
|
-
|
|
57
|
-
```bash
|
|
58
|
-
farai setup \
|
|
59
|
-
--model openai:gpt-5 \
|
|
60
|
-
--base-url https://api.openai.com/v1 \
|
|
61
|
-
--api-key-env OPENAI_API_KEY
|
|
62
|
-
```
|
|
63
|
-
|
|
64
|
-
Skip heavier setup steps when needed:
|
|
65
|
-
|
|
66
|
-
```bash
|
|
67
|
-
farai setup --no-docker
|
|
68
|
-
farai setup --no-kb
|
|
69
|
-
```
|
|
70
|
-
|
|
71
|
-
Check the environment:
|
|
72
|
-
|
|
73
|
-
```bash
|
|
74
|
-
farai doctor
|
|
75
|
-
```
|
|
76
|
-
|
|
77
44
|
## Usage
|
|
78
45
|
|
|
79
|
-
Open the interactive
|
|
46
|
+
Open the interactive:
|
|
80
47
|
|
|
81
48
|
```bash
|
|
82
49
|
farai
|
|
83
50
|
```
|
|
84
51
|
|
|
85
|
-
Run a one-shot prompt:
|
|
86
|
-
|
|
87
|
-
```bash
|
|
88
|
-
farai run "scan the target and summarize exposed services"
|
|
89
|
-
```
|
|
90
|
-
|
|
91
|
-
Create a named session:
|
|
92
|
-
|
|
93
|
-
```bash
|
|
94
|
-
farai init --name htb-box --target 10.10.10.10
|
|
95
|
-
```
|
|
96
|
-
|
|
97
|
-
Resume a session:
|
|
98
|
-
|
|
99
|
-
```bash
|
|
100
|
-
farai resume htb-box
|
|
101
|
-
```
|
|
102
|
-
|
|
103
|
-
Change or add a model provider:
|
|
104
|
-
|
|
105
|
-
```bash
|
|
106
|
-
farai model
|
|
107
|
-
farai model add openai/gpt-5 --base-url https://api.openai.com/v1 --api-key-env OPENAI_API_KEY --set-default
|
|
108
|
-
```
|
|
109
|
-
|
|
110
|
-
Run benchmark manifests:
|
|
111
|
-
|
|
112
|
-
```bash
|
|
113
|
-
farai bench run manifest.json --artifacts /tmp/farai-results
|
|
114
|
-
farai bench suite suite.json --artifacts /tmp/farai-results
|
|
115
|
-
```
|
|
116
|
-
|
|
117
|
-
## Commands
|
|
118
|
-
|
|
119
|
-
| Command | Description |
|
|
120
|
-
|---|---|
|
|
121
|
-
| `farai` | Open the interactive terminal UI |
|
|
122
|
-
| `farai setup` | Prepare config, Docker runtime, local data, and optional model provider |
|
|
123
|
-
| `farai run` | Execute a one-shot prompt |
|
|
124
|
-
| `farai resume` | Continue a saved session |
|
|
125
|
-
| `farai init` | Create a named session |
|
|
126
|
-
| `farai model` | List or add model providers |
|
|
127
|
-
| `farai bench` | Run benchmark manifests and suites |
|
|
128
|
-
| `farai doctor` | Verify the local environment |
|
|
129
|
-
| `farai config` | Print config and auth paths |
|
|
130
|
-
|
|
131
52
|
Config and auth files live under:
|
|
132
53
|
|
|
133
54
|
```text
|