mirror of
https://github.com/mvschwarz/openrig.git
synced 2026-11-07 05:56:21 -10:00
Mike Schwarz
c750304f73
Front-door documents re-verified against main for 0.6.6. Facts only; structure, voice and the README anchor are unchanged. - README: rig setup installs a missing harness (and cmux on macOS); rig seat continue for a seat stopped at a prompt; the npm install table names rig and openrig-tui and adds a bundle-install row; Codex network access on the plain sandbox; the OPENRIG_YOLO, builtin:auto and --non-interruptive launch effects; restore outcomes, bundle links and checks, and the default culture; later release notes in CHANGELOG.md. - CONTRIBUTING: tmux version in bug reports, the docs guard, context packs not committed, the UI suite runs in CI, and the skills locations. - SUPPORT: the agent help page URL, the support email already published in help.md, and tmux and harness details in bug reports. - SECURITY: the provider and project files OpenRig writes, and the tmux and cmux edits made by rig setup.
21 lines
1.4 KiB
Markdown
21 lines
1.4 KiB
Markdown
# Getting help with OpenRig
|
||
|
||
- **Docs:** https://openrig.dev/docs — getting started, CLI reference, configuration,
|
||
troubleshooting. An index linking to agent-friendly documentation is at
|
||
https://openrig.dev/llms.txt.
|
||
- **Agents helping a user:** read [docs/reference/help.md](../docs/reference/help.md), or run `rig context get help`.
|
||
The same guide is at https://www.openrig.dev/help/agents.
|
||
- **Email:** hello@openrig.dev, which needs no GitHub account.
|
||
- **Questions:** [Discussions › Q&A](https://github.com/mvschwarz/openrig/discussions/categories/q-a).
|
||
- **Bugs:** [open an issue](https://github.com/mvschwarz/openrig/issues/new/choose) with the bug
|
||
template. Include `rig --version`, your OS, Node and tmux versions, the harnesses involved, and
|
||
relevant redacted command output.
|
||
Reports are public: remove credentials, private prompts and personal information.
|
||
- **Ideas and setups:** [Ideas](https://github.com/mvschwarz/openrig/discussions/categories/ideas)
|
||
and [Show and tell](https://github.com/mvschwarz/openrig/discussions/categories/show-and-tell).
|
||
- **Videos:** https://www.youtube.com/@openrig
|
||
- **Security:** see [SECURITY.md](../SECURITY.md); please report privately.
|
||
|
||
We aim to acknowledge issues and pull requests within one day. A substantive PR review decision
|
||
within seven days is a target, not a guaranteed deadline. Details in [CONTRIBUTING.md](../CONTRIBUTING.md).
|