openrig-user-settings

Name: openrig-user-settings
Author: mvschwarz

56stars9forks

How to install openrig-user-settings?

mvschwarz/openrig/openrig-user-settings

$npx -y skills add mvschwarz/openrig --skill openrig-user-settings

Installs into the current project.

Summary

Use when the user asks an OpenRig agent to read or change OpenRig configuration settings — workspace paths, file allowlists, progress scan roots, daemon port/host, transcripts, or anything stored in ~/.openrig/config.json

Files · 1

View on GitHub

SKILL.md

1	# OpenRig User Settings
2
3	OpenRig settings live in `~/.openrig/config.json` and are managed via the
4	`rig config` CLI family. The agent-editable surface is CLI shell-out;
5	do NOT write the JSON file directly unless the operator specifically asks
6	for raw-text editing (which is handled by the UI Files browser, not by you).
7
8	## Read
9
10	```bash
11	rig config # all keys, value + source
12	rig config --json # JSON: full RiggedConfig
13	rig config --json --with-source # JSON: {key: {value, source, default}}
14	rig config get <key> # single value
15	rig config get <key> --show-source # value + source on one line
16	rig config get <key> --json # {value, source, default}
17	```
18
19	Resolution order: env var > config file > default. Always use
20	`--show-source` (or `--json`) when reporting back to the operator so they
21	see where the value came from.
22
23	## Write
24
25	```bash
26	rig config set <key> <value> # set a key
27	rig config reset <key> # clear one override (revert to default)
28	rig config reset # delete the whole file
29	```
30
31	## Initialize a default workspace
32
33	```bash
34	rig config init-workspace # scaffold ~/.openrig/workspace/ with missions + slices
35	rig config init-workspace --dry-run # show what would be created
36	rig config init-workspace --root /path # use a custom root
37	rig config init-workspace --force # overwrite scaffolded files (NOT operator content)
38	```
39
40	This creates a file-backed Project workspace under the workspace root:
41
42	```text
43	README.md
44	STEERING.md
45	missions/<mission-id>/README.md
46	missions/<mission-id>/PROGRESS.md
47	missions/<mission-id>/slices/<slice-id>/README.md
48	progress/
49	field-notes/
50	specs/
51	```
52
53	It seeds two starter missions with multiple slices so the Project UI has a
54	real mission/slice map out of the box. It is operator-explicit; do NOT run it
55	on your own initiative unless the operator asks for workspace initialization
56	or repair.
57
58	## Common keys
59
60	\| Key \| Type \| Purpose \|
61	\|---\|---\|---\|
62	\| `daemon.port` \| number \| OpenRig daemon HTTP port (default 7433) \|
63	\| `daemon.host` \| string \| Daemon bind host (default 127.0.0.1) \|
64	\| `db.path` \| string \| SQLite DB path (default ~/.openrig/openrig.sqlite) \|
65	\| `transcripts.enabled` \| boolean \| Whether the daemon writes transcripts \|
66	\| `transcripts.path` \| string \| Transcripts dir (default ~/.openrig/transcripts) \|
67	\| `workspace.root` \| string \| Single-root override (default ~/.openrig/workspace) \|
68	\| `workspace.slices_root` \| string \| Slice discovery root; default `<root>/missions` \|
69	\| `workspace.steering_path` \| string \| STEERING.md path; default `<root>/STEERING.md` \|
70	\| `workspace.field_notes_root` \| string \| Field notes dir; default `<root>/field-notes` \|
71	\| `workspace.specs_root` \| string \| Specs dir; default `<root>/specs` \|
72	\| `files.allowlist` \| string \| `name:/abs/path,name:/abs/path` — UI Files browser roots \|
73	\| `progress.scan_roots` \| string \| `name:/abs/path,name:/abs/path` — Progress browse roots \|
74
75	Resolution order for workspace per-subdir keys: per-subdir override >
76	`workspace.root` cascade > built-in default.
77
78	## Common operator requests → canonical commands
79
80	> "Make the UI work against an existing workspace layout":
81	> set the per-subdir workspace overrides explicitly:
82	>
83	> ```bash
84	> rig config set workspace.slices_root /path/to/your/workspace/missions
85	> rig config set workspace.steering_path /path/to/your/workspace/STEERING.md
86	> rig config set workspace.progress_scan_roots 'work:/path/to/your/workspace,missions:/path/to/your/workspace/missions'
87	> rig config set workspace.field_notes_root /path/to/your/workspace/field-notes
88	> ```
89	>
90	> No restart needed for the CLI; for the daemon's reads to pick up
91	> changes affecting startup-time wiring (`files.allowlist`,
92	> `progress.scan_roots`), restart with `rig daemon restart`.
93
94	> "Initialize a default workspace":
95	>
96	> ```bash
97	> rig config init-workspace
98	> ```
99
100	After initialization, the Project UI expects this mapping:
101
102	- `workspace.root` maps to the Project workspace.
103	- `workspace.root/missions/<mission-id>` maps to a Project mission.
104	- `workspace.root/missions/<mission-id>/slices/<slice-id>` maps to a Project slice.
105
106	Queue item bodies or tags should mention the mission id and slice id when the
107	work belongs to a slice. That lets the Project Story, Queue, Tests, and
108	Topology tabs attach runtime work to the filesystem slice.
109
110	> "Allow the file browser to see X directory":
111	>
112	> ```bash
113	> # Append to existing list (operator decides the name token):
114	> rig config get files.allowlist --show-source # check current
115	> rig config set files.allowlist 'workspace:/path/to/ws,docs:/path/to/do

People who liked this also viewed

6 picks

Type

openrig-user-settings

56stars9forks

View on GitHub

How to install openrig-user-settings?

mvschwarz/openrig/openrig-user-settings

$npx -y skills add mvschwarz/openrig --skill openrig-user-settings

Installs into the current project.

Summary

Files · 1

View on GitHub

SKILL.md

1	# OpenRig User Settings
2
3	OpenRig settings live in `~/.openrig/config.json` and are managed via the
4	`rig config` CLI family. The agent-editable surface is CLI shell-out;
5	do NOT write the JSON file directly unless the operator specifically asks
6	for raw-text editing (which is handled by the UI Files browser, not by you).
7
8	## Read
9
10	```bash
11	rig config # all keys, value + source
12	rig config --json # JSON: full RiggedConfig
13	rig config --json --with-source # JSON: {key: {value, source, default}}
14	rig config get <key> # single value
15	rig config get <key> --show-source # value + source on one line
16	rig config get <key> --json # {value, source, default}
17	```
18
19	Resolution order: env var > config file > default. Always use
20	`--show-source` (or `--json`) when reporting back to the operator so they
21	see where the value came from.
22
23	## Write
24
25	```bash
26	rig config set <key> <value> # set a key
27	rig config reset <key> # clear one override (revert to default)
28	rig config reset # delete the whole file
29	```
30
31	## Initialize a default workspace
32
33	```bash
34	rig config init-workspace # scaffold ~/.openrig/workspace/ with missions + slices
35	rig config init-workspace --dry-run # show what would be created
36	rig config init-workspace --root /path # use a custom root
37	rig config init-workspace --force # overwrite scaffolded files (NOT operator content)
38	```
39
40	This creates a file-backed Project workspace under the workspace root:
41
42	```text
43	README.md
44	STEERING.md
45	missions/<mission-id>/README.md
46	missions/<mission-id>/PROGRESS.md
47	missions/<mission-id>/slices/<slice-id>/README.md
48	progress/
49	field-notes/
50	specs/
51	```
52
53	It seeds two starter missions with multiple slices so the Project UI has a
54	real mission/slice map out of the box. It is operator-explicit; do NOT run it
55	on your own initiative unless the operator asks for workspace initialization
56	or repair.
57
58	## Common keys
59
60	\| Key \| Type \| Purpose \|
61	\|---\|---\|---\|
62	\| `daemon.port` \| number \| OpenRig daemon HTTP port (default 7433) \|
63	\| `daemon.host` \| string \| Daemon bind host (default 127.0.0.1) \|
64	\| `db.path` \| string \| SQLite DB path (default ~/.openrig/openrig.sqlite) \|
65	\| `transcripts.enabled` \| boolean \| Whether the daemon writes transcripts \|
66	\| `transcripts.path` \| string \| Transcripts dir (default ~/.openrig/transcripts) \|
67	\| `workspace.root` \| string \| Single-root override (default ~/.openrig/workspace) \|
68	\| `workspace.slices_root` \| string \| Slice discovery root; default `<root>/missions` \|
69	\| `workspace.steering_path` \| string \| STEERING.md path; default `<root>/STEERING.md` \|
70	\| `workspace.field_notes_root` \| string \| Field notes dir; default `<root>/field-notes` \|
71	\| `workspace.specs_root` \| string \| Specs dir; default `<root>/specs` \|
72	\| `files.allowlist` \| string \| `name:/abs/path,name:/abs/path` — UI Files browser roots \|
73	\| `progress.scan_roots` \| string \| `name:/abs/path,name:/abs/path` — Progress browse roots \|
74
75	Resolution order for workspace per-subdir keys: per-subdir override >
76	`workspace.root` cascade > built-in default.
77
78	## Common operator requests → canonical commands
79
80	> "Make the UI work against an existing workspace layout":
81	> set the per-subdir workspace overrides explicitly:
82	>
83	> ```bash
84	> rig config set workspace.slices_root /path/to/your/workspace/missions
85	> rig config set workspace.steering_path /path/to/your/workspace/STEERING.md
86	> rig config set workspace.progress_scan_roots 'work:/path/to/your/workspace,missions:/path/to/your/workspace/missions'
87	> rig config set workspace.field_notes_root /path/to/your/workspace/field-notes
88	> ```
89	>
90	> No restart needed for the CLI; for the daemon's reads to pick up
91	> changes affecting startup-time wiring (`files.allowlist`,
92	> `progress.scan_roots`), restart with `rig daemon restart`.
93
94	> "Initialize a default workspace":
95	>
96	> ```bash
97	> rig config init-workspace
98	> ```
99
100	After initialization, the Project UI expects this mapping:
101
102	- `workspace.root` maps to the Project workspace.
103	- `workspace.root/missions/<mission-id>` maps to a Project mission.
104	- `workspace.root/missions/<mission-id>/slices/<slice-id>` maps to a Project slice.
105
106	Queue item bodies or tags should mention the mission id and slice id when the
107	work belongs to a slice. That lets the Project Story, Queue, Tests, and
108	Topology tabs attach runtime work to the filesystem slice.
109
110	> "Allow the file browser to see X directory":
111	>
112	> ```bash
113	> # Append to existing list (operator decides the name token):
114	> rig config get files.allowlist --show-source # check current
115	> rig config set files.allowlist 'workspace:/path/to/ws,docs:/path/to/do

People who liked this also viewed

6 picks

Type