Help System Messages
See Errors & Warnings Catalog for the full index, and Errors & Warnings Guide for a narrative explanation of message categories, exit codes, and common fixes.
Messages from the built-in help system, which provides usage documentation via ssi help.
| Message | Exit Code | Hint |
|---|---|---|
| ❌ Embedded help config file not found in compiled binary | 1 | 💡 The embedded help configuration should always be present in an official build — try reinstalling SSI or rebuilding from source. If it still fails, report a bug and include your SSI version and how you installed it. |
| ❌ Help config step missing required 'path' field at index [index] | 3 | 💡 Please report as a bug — include the SSI version, the step index above, and your help configuration (or how you invoke help). |
| ❌ Help system internal error: config parse failed: [error message] | 1 | 💡 Please report as a bug — include the SSI version and the parse error text above. |
| ❌ Help content missing for embedded path: [path] | 1 | 💡 This is an internal error — the help system data may be incomplete. Please report this as a bug. |
| ❌ Help system internal error: engine initialization failed: [error message] | 1 | 💡 Please report as a bug — include the SSI version and the engine initialization error text above. |
| ❌ Invalid help invocation — too many arguments: 💬identity_help_arguments. Use `ssi help`, `ssi help TOPIC`, or `ssi help DESTINATION TOPIC`. | 2 | 💡 Help accepts at most two words after `ssi help` (optional destination plus topic). |
| ❌ Help system internal error: unexpected file path with no .md suffix: [path] | 1 | 💡 Please report as a bug — include the SSI version and the path above. |
| ❌ Help system internal error: content processing failed: [error message] | 1 | 💡 Please report as a bug — include the help topic you requested and the error text above. |
| ❌ Help template processing failed: [error message] | 1 | 💡 Address the engine warning in the help source or config — help output requires templates to be warning-free, and the detail above names what failed |
| ❌ Help topic not found: [topic] | 2 | 💡 Run `ssi help` to see the list of available help topics |
| This is a bug — please report it. Command: [command] | 💡 Include the backtrace and any output printed above, plus your SSI version, when you report. | |
| Validating [command] (dry run) |