Guides¶
Use these guides when you know the outcome you need and want a safe procedure for reaching it. For exact field shapes and command behavior, use the reference.
Review and apply policy¶
Build a deterministic plan, interpret blocked operations, confirm deliberate changes, and recover from partial failure.
Govern the organization itself¶
Introduce Octoform to an account that already has repositories, people and teams, in an order where each step is reviewable on its own.
Verify against a test organization¶
Prove convergence, idempotence and every refusal on an organization you can afford to throw away, before pointing Octoform at a real one.
Operate across several accounts¶
Introduce a second account, narrow a run before widening it, and read a report that spans more than one owner.
Automate safely¶
Separate pull-request planning, scheduled observation, and protected mutation with credentials appropriate to each boundary.
Start from a validated policy¶
Choose a focused configuration, download the original YAML, and adapt only the owner and repositories you intend to govern.
Find the right kind of answer¶
| When you need to... | Continue with... |
|---|---|
| Install Octoform and produce a first read-only plan | Quick start |
| Add or remove one person from an organization | octoform members |
| Understand omission, precedence, and blocked changes | Core concepts |
| Diagnose an unexpected result | Troubleshooting |
| Look up an accepted field or CLI option | Reference |
| Evaluate runtime or trust boundaries | Architecture |
| Select and protect a credential | Security |