trending/openrig
1
0
Fork 0
mirror of https://github.com/mvschwarz/openrig.git synced 2026-10-02 00:27:21 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(cli): clarify context trace seat value (#323)

Browse Source
This commit is contained in:
Wu Shuwen
2026-10-01 08:03:13 -07:00
committed by GitHub
parent e5681fc4c8
commit dc6ab9eed5
2 changed files with 9 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/cli/src/commands/context.ts
+1 -1
View File
@@ -377,7 +377,7 @@ Examples:
.description("Walk the topology tree for one chain filename (instance -> rig -> optional pod -> optional seat), keyed off topology.root")
.requiredOption("--rig <rig>", "Rig name (the rigs/<rig> altitude)")
.option("--pod <pod>", "Pod id (the pods/<pod> altitude); omit when no pod context is selected")
.option("--seat <seat>", "Seat id (the seats/<seat> altitude); omit for a rig-level trace")
.option("--seat <seat>", "Seat folder name (<pod>-<member>, e.g. dev1-qa); omit for a rig-level trace")
.requiredOption("--name <file>", "Chain filename, identical at every altitude (e.g. LEARNED.md, CULTURE.md)")
.option("--json", "JSON output for agents")
.action(async (opts: { rig: string; pod?: string; seat?: string; name: string; json?: boolean }) => {
packages/cli/test/context.test.ts
+8
View File
@@ -94,6 +94,14 @@ const FIXTURE_PREVIEW = {
};
describe("rig context CLI (PL-014)", () => {
it("describes --seat as a seat folder name", () => {
const trace = contextCommand().commands.find((command) => command.name() === "trace");
const seatOption = trace?.options.find((option) => option.long === "--seat");
expect(seatOption?.description).toContain("Seat folder name");
expect(seatOption?.description).toContain("<pod>-<member>");
expect(seatOption?.description).toContain("dev1-qa");
});
let server: http.Server;
let port: number;
let composeLog: Array<{ outRef?: string; sources?: Array<{ path: string; label: string }> }>;