Quick start
# Inspect the installed surface
sock --help
sock capabilities --json
# Read one harness's state across stages
sock status --capture cap-...
# Read every harness under the store in one pass
sock status --all
Supported documentation boundary
The installed engine contains many commands used by the desktop application to scan sources, extract and synthesize knowledge, build the graph and Asset Inventory, answer questions, and manage releases. Those write and orchestration commands are deliberately not reproduced here: their existence does not make them a supported end-user capability, and invoking them directly can bypass the sequencing and recovery provided by MSOCK.
Use the application for all state-changing work. If a support investigation requires a deeper engine command, use the syntax reported by the installed version's --help and follow instructions from your organisation's MSOCK support or platform team.
Common task mapping
| Goal | Entry command | Check first |
|---|---|---|
| Inspect the engine surface | sock --help | The installed engine version |
| Read capability profiles | sock capabilities --json | Application and engine compatibility |
| Read a harness's state | sock status --capture cap-... | The correct harness id |
| Read every harness at once | sock status --all | This produces structured output and may be large |
Credentials and sensitive data
Do not put credentials, tokens, connection strings, customer data, or other secrets into a command line, shell history, support ticket, or copied diagnostic output. Configure source credentials through the MSOCK interface, which stores and passes them through the supported protected path.
Qualification
- A command existing does not mean the matching end-user capability is available or supported.
- Use the installed version's
--helpas the syntax reference during a controlled support investigation; the surface changes between engine versions. - There is no published stability or scripting-support contract for external automation.
- Do not treat the private backend or any auto-generated service documentation as a public API.
- Supported write paths refuse to operate on a harness downloaded from somebody else's published release.