Skip to content

Commit 43828e3

Browse files
committed
Document Office Plane CLI commands and defaults
1 parent b1d720c commit 43828e3

1 file changed

Lines changed: 37 additions & 0 deletions

File tree

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ It should contain:
1919
- guardrail/eval/evidence helpers;
2020
- agent sandbox/run helpers;
2121
- Agent Machine local mount and secure host-interface helpers;
22+
- Office Plane dry-run, inspection, and evidence helpers;
2223
- fingerprint and proof bundle tools;
2324
- local-to-mesh registration helpers;
2425
- release/operator install scripts.
@@ -63,6 +64,12 @@ sourceosctl [--version] <command> [<subcommand>] [options]
6364
| `sourceosctl agent-machine mounts init --dry-run` | Render mount initialization plan; no directories or mounts are created |
6465
| `sourceosctl agent-machine mounts inspect [--include-downloads]` | Inspect default/local Agent Machine mount posture |
6566
| `sourceosctl agent-machine mounts evidence inspect <path>` | Inspect Agent Machine mount evidence JSON (read-only) |
67+
| `sourceosctl office doctor` | Inspect local Office Plane backend availability, including LibreOffice detection |
68+
| `sourceosctl office plan` | Render an OfficeArtifact-compatible workroom artifact plan |
69+
| `sourceosctl office generate --dry-run` | Render an Office generation plan without writing files |
70+
| `sourceosctl office convert <path> --to <format> --dry-run` | Render a LibreOffice-style conversion plan without writing files |
71+
| `sourceosctl office inspect <path>` | Inspect a local office artifact file and hash it |
72+
| `sourceosctl office evidence inspect <path>` | Inspect Office Plane evidence JSON (read-only) |
6673

6774
### Running from the repo
6875

@@ -81,6 +88,10 @@ python3 bin/sourceosctl agents sandbox plan --dry-run
8188
python3 bin/sourceosctl agent-machine mounts plan
8289
python3 bin/sourceosctl agent-machine mounts init --dry-run
8390
python3 bin/sourceosctl agent-machine mounts inspect --include-downloads
91+
python3 bin/sourceosctl office doctor
92+
python3 bin/sourceosctl office plan --artifact-type slide-deck --format pptx --title "Demo Deck"
93+
python3 bin/sourceosctl office generate --dry-run --artifact-type document --format docx --title "Demo Report"
94+
python3 bin/sourceosctl office convert ./example.docx --to pdf --dry-run
8495
```
8596

8697
### Agent Machine local mount defaults
@@ -103,6 +114,31 @@ The CLI does **not** mount `$HOME` wholesale and does **not** expose `.ssh`, `.g
103114

104115
TopoLVM is treated as a Linux cluster-local backend profile for the same logical mount contract. It is not used for macOS/APFS local mode and it is not represented as cross-node shared storage.
105116

117+
### Office Plane local defaults
118+
119+
The first Office Plane slice is dry-run/read-only. It aligns with `SocioProphet/prophet-workspace`:
120+
121+
- `ProfessionalWorkroom`
122+
- `OfficeArtifact`
123+
124+
Default paths:
125+
126+
| Purpose | Host path | Agent path |
127+
| --- | --- | --- |
128+
| Workroom output | `~/Documents/SourceOS/agent-output` | `/workspace/output` |
129+
| Browser downloads | `~/Downloads/SourceOS/agent-downloads` | `/workspace/downloads` |
130+
| Code/templates | `~/dev` | `/workspace/dev` |
131+
132+
Backends are modeled as an abstraction:
133+
134+
- LibreOffice: local-first default for headless generation, inspection, render, and conversion.
135+
- Collabora: future browser-collaboration / WOPI-style backend.
136+
- ONLYOFFICE: future optional document-builder/editor backend.
137+
- Microsoft Graph / Office 365 and Google Workspace: compatibility adapters, not core authority.
138+
- SourceOS-native: future native document surfaces.
139+
140+
The CLI does not create, convert, or modify files yet. It renders plans and inspects artifacts/evidence. Email sending and external publishing remain policy-gated side effects and are not enabled here.
141+
106142
### Design constraints
107143

108144
All commands in the current surface are **read-only or dry-run**. No mutating command is implemented. Commands that would mutate host state are explicitly rejected at runtime.
@@ -125,6 +161,7 @@ M1 is repo maturity and install surface definition:
125161
- `SourceOS-Linux/sourceos-boot`: SourceOS boot/recovery integration.
126162
- `SourceOS-Linux/agent-term`: terminal-native SourceOS operator ChatOps console.
127163
- `SociOS-Linux/workstation-contracts`: workstation/CI conformance contracts and IPC receipts.
164+
- `SocioProphet/prophet-workspace`: workspace product semantics, Professional Workrooms, and OfficeArtifact contracts.
128165
- `SocioProphet/homebrew-prophet`: Homebrew install formulae.
129166
- `SocioProphet/model-router`: governed model/service routing.
130167
- `SocioProphet/guardrail-fabric`: guardrail policy client integration.

0 commit comments

Comments
 (0)