Skip to content

Commit 293fb9b

Browse files
committed
Release RelayX v0.1.16 colorized UX
1 parent 540b3c4 commit 293fb9b

20 files changed

Lines changed: 581 additions & 87 deletions

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -206,8 +206,9 @@ relayx -q paths examples/tutorial/sample-result.json -b
206206
relayx -q bundle -r examples/tutorial/sample-result.json -d /tmp/relayx-tutorial-bundle
207207
```
208208

209-
Read the full runbook in [docs/TUTORIAL.md](docs/TUTORIAL.md). The tutorial
210-
fixtures live in [examples/tutorial](examples/tutorial).
209+
Read the full runbook in [docs/TUTORIAL.md](docs/TUTORIAL.md), or use the
210+
Chinese version in [docs/TUTORIAL.zh-CN.md](docs/TUTORIAL.zh-CN.md). The
211+
tutorial fixtures live in [examples/tutorial](examples/tutorial).
211212
Authorized AD/IIS/AD CS/MSSQL lab expectations are documented in
212213
[docs/INTEGRATION_TESTS.md](docs/INTEGRATION_TESTS.md).
213214

@@ -303,14 +304,15 @@ guardrails.
303304
## Operator Console And Completion
304305

305306
RelayX includes a local operator console for repeated analysis on the same
306-
result and path. It is not a C2 client and does not start listeners, pivot
307-
sessions, source triggers, or live relay adapters; it calls the same guarded
308-
CLI handlers with remembered context.
307+
result and path. It keeps result, path, OPSEC policy, and scope context in the
308+
prompt, then calls the same guarded CLI handlers you already use in scripted
309+
workflows.
309310

310311
```bash
311312
relayx console --result result.json --path-id PX-0001 --opsec-policy strict
312313
relayx completion zsh > relayx.zsh
313314
relayx help getting-started
315+
relayx --no-color help run
314316
```
315317

316318
Inside the console, use commands such as `use result <file>`, `use path

docs/CLI.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ for grouped command help, short-option documentation, shell completion, and
77
quality-gate drift checks.
88

99
For a complete end-to-end offline walkthrough, use
10-
[`docs/TUTORIAL.md`](TUTORIAL.md) with the fixtures in
10+
[`docs/TUTORIAL.md`](TUTORIAL.md) or
11+
[`docs/TUTORIAL.zh-CN.md`](TUTORIAL.zh-CN.md) with the fixtures in
1112
[`examples/tutorial`](../examples/tutorial).
1213
Authorized AD/IIS/AD CS/MSSQL integration-test expectations are documented in
1314
[`docs/INTEGRATION_TESTS.md`](INTEGRATION_TESTS.md).
@@ -75,15 +76,15 @@ Next steps
7576
## Operator Console
7677

7778
`relayx console` provides a local, single-process operator shell for repeated
78-
work on the same result, path, OPSEC policy, and scope. It is inspired by
79-
mature operator consoles, but it is not a C2 runtime: there is no server-client
80-
split, no listener start, no pivot-session operation, no source-side trigger
81-
execution, and no live relay adapter registration.
79+
work on the same result, path, OPSEC policy, and scope. It keeps the current
80+
operator context visible in the prompt and reuses the same RelayX CLI handlers
81+
and guardrails as scripted workflows.
8282

8383
```bash
8484
relayx console
8585
relayx console --result examples/tutorial/sample-result.json --path-id PX-0001 --opsec-policy strict
8686
relayx console --script console.txt
87+
relayx --no-color console --result examples/tutorial/sample-result.json
8788
```
8889

8990
The prompt reflects context:
@@ -138,6 +139,10 @@ relayx completion fish > relayx.fish
138139
Completion only suggests syntax. It does not weaken authorization, OPSEC,
139140
scope, audit, or adapter checks.
140141

142+
ANSI color is enabled by default for human-readable curated help and console
143+
output. Use `--no-color` or the `NO_COLOR` environment variable for plain text.
144+
Machine-readable output and generated completion scripts are never colorized.
145+
141146
## Short Options
142147

143148
RelayX exposes short aliases for high-use options. Long options remain the

docs/README.zh-CN.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,8 @@ relayx -q paths examples/tutorial/sample-result.json -b
190190
relayx -q bundle -r examples/tutorial/sample-result.json -d /tmp/relayx-tutorial-bundle
191191
```
192192

193-
完整 runbook 见 [docs/TUTORIAL.md](TUTORIAL.md)。示例 fixture 位于
193+
完整英文 runbook 见 [docs/TUTORIAL.md](TUTORIAL.md),中文版本见
194+
[docs/TUTORIAL.zh-CN.md](TUTORIAL.zh-CN.md)。示例 fixture 位于
194195
[examples/tutorial](../examples/tutorial)
195196
授权 AD/IIS/AD CS/MSSQL lab 的 integration-test 期望见
196197
[docs/INTEGRATION_TESTS.md](INTEGRATION_TESTS.md)
@@ -286,14 +287,14 @@ relayx quality-gate -C . -f json -o relayx-quality-gate.json
286287
## Operator Console 与 Completion
287288

288289
`relayx console` 是本地单进程 operator console,用来在同一个 result、path、
289-
OPSEC policy 和 scope 上重复分析。它不是 C2 client,不启动 listener、pivot
290-
session、source trigger 或 live relay adapter;console 命令仍调用同一套 CLI
291-
handler 和 guardrail。
290+
OPSEC policy 和 scope 上重复分析。它会在 prompt 中显示当前上下文,并调用与
291+
脚本化 workflow 相同的 CLI handler 和 guardrail。
292292

293293
```bash
294294
relayx console --result result.json --path-id PX-0001 --opsec-policy strict
295295
relayx completion zsh > relayx.zsh
296296
relayx help getting-started
297+
relayx --no-color help run
297298
```
298299

299300
console 内可使用 `use result <file>``use path PX-0001`、`set opsec-policy

docs/TUTORIAL.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -72,13 +72,14 @@ relayx -q schema validate -k result examples/tutorial/baseline-result.json
7272

7373
The expected validation result is `valid: true` with zero errors.
7474

75-
You can also use `relayx console`, the local operator console, for repeated work on the same
76-
result. The console remembers selected result, path, OPSEC policy, and scope;
77-
it still calls the same CLI handlers and does not start listeners, pivots,
78-
source triggers, or live relay adapters.
75+
You can also use `relayx console`, the local operator console, for repeated
76+
work on the same result. The console remembers selected result, path, OPSEC
77+
policy, and scope, then calls the same guarded CLI handlers used by scripted
78+
workflows.
7979

8080
```bash
8181
relayx -q console --result examples/tutorial/sample-result.json --path-id PX-0001 --opsec-policy strict
82+
relayx --no-color -q console --result examples/tutorial/sample-result.json
8283
```
8384

8485
Example console commands:
@@ -174,8 +175,7 @@ relayx -q schema validate -k route-report /tmp/relayx-routes.json
174175

175176
Route and pivot awareness is model-driven. RelayX uses source metadata such as
176177
`session`, `segment`, `subnets`, and structured `route_hops` to explain likely
177-
reachability and route risk. It does not open Ligolo, Sliver, SOCKS,
178-
tun2socks, or port-forward sessions.
178+
reachability, route constraints, and route risk.
179179

180180
In an authorized lab or assessment window, you can add a direct TCP observation
181181
without opening a pivot session:

0 commit comments

Comments
 (0)