Guides
Choose the task you want to complete. Each guide gives you the safe sequence, the important boundary, and a way to verify the result. When you need exact syntax, it links into the command tree generated from ngit's own CLI definitions:
- stable ngit reference: complete command syntax for the current stable release;
- upcoming reference: an older pinned integration snapshot retained for provenance.
Use this page to find the guide. Use the generated pages for exhaustive flags, defaults, conflicts, and accepted values.
Repositories
| Task | Guide | CLI reference |
|---|---|---|
| Publish a repository | Repositories | ngit init |
| Publish or access a private repository | Private repositories | ngit init |
| Inspect metadata and hosting | Repositories | ngit repo |
| Edit metadata or providers | Repositories | ngit repo edit |
| Accept, leave, or follow a roster | Maintainers | ngit repo |
| Synchronise Git servers | Repositories | ngit sync |
| Mirror to GitHub or another forge | Mirroring | ngit sync |
Pull requests and issues
| Task | Guide | CLI reference |
|---|---|---|
Open a PR by pushing pr/* | Pull requests | ngit send for advanced input |
| List, view, review, or edit PRs | Pull requests | ngit pr |
| Merge a PR | Pull requests | ngit pr merge |
| Create or manage issues | Issues | ngit issue |
Releases, CI, and publication
| Task | Guide | CLI reference |
|---|---|---|
| Check for or install an ngit update | Install | ngit update |
| Publish and verify software releases | Releases | ngit release |
| Write a release manifest | Release manifest | ngit release publish |
| Choose a coordinator and request CI | CI | ngit ci request |
| Write a CI workflow | act workflow files | ngit ci |
| Read results or gate a merge on CI | CI | ngit ci status |
| Rerun a workflow | CI | ngit ci trigger |
| Publish a static NIP-5A site | Nsites | ngit nsite |
| Publish an OCI image | Generated reference | ngit container |
Accounts and coding agents
| Task | Guide | CLI reference |
|---|---|---|
| Log in, create, select, or remove identities | Accounts & keys | ngit account |
| Install or update the repository skill | Agent automation | ngit skill |
Automation rules
- Add
--jsonwhen the command supports machine-readable output. It writes one JSON document to stdout and keeps diagnostics on stderr. - After an initial online read has populated the cache, add
--offlinewhere the specific generated command page lists it. - Select ambiguous repositories with
--repo <REMOTE|NADDR|NOSTR-URL>. - Prefer secret-file options over inline secret arguments in CI.
Do not infer that a global-looking flag works everywhere. The generated page for each command is the authority.