The scm reef¶
Every command that lets Nereus reach a source host as an application, never as a person.
Commands¶
nereus nereid apply github
One github Nereid serves both reefs, opt-innereus scm connection create example
A Connection names an organisation, and nothing secretnereus scm connection list
list says what each App reaches, and what is missingnereus scm connection delete labs
delete removes the Connection, never the Appnereus nereid apply forgejo
The forgejo Nereid runs Forgejo in the cluster, in the profilenereus scm mirror create nereus
A Mirror copies a repository into the clusternereus scm mirror list
list shows the commit each copy holds
Examples¶
apply-github¶
Apply the github Nereid to both reefs.
nereus nereid apply github \
--reef authentication \
--reef scm
output
✓ core/nereids/github created, Ready, pinned to sha256:1e74cbc6a968: see 'nereus authentication --help'
namespaces/nereus-system-github applied (the github Nereid's Role there, where vault default delivers the App keys)
Next steps:
nereus mandate create github --reef authentication --nereid github --param appId=<id> --param privateKey=<secret> --param allow=<namespace>:<repository>:<permission>=<level> --default
nereus mandate create github-scm --reef scm --nereid github --param identity=github --default
connection-create¶
The organisation, through the reef's default Mandate.
nereus scm connection create example \
--org example
output
✓ scm/connections/example created (mandate github-scm)
Next steps:
nereus scm connection get example
connection-list¶
Every Connection, with its status.
nereus scm connection list
output
CONNECTION ORG MANDATE STATUS DEFAULT
example example github-scm Ready yes
labs example-labs github-scm NotInstalled no
meta example-meta github-scm MissingPermissions no
some example-some github-scm NotAllRepositories no
connection-delete¶
Remove the Connection.
nereus scm connection delete labs
output
✓ scm/connections/labs deleted
Next steps:
nereus scm connection list
mirror-apply¶
Apply the forgejo Nereid to the scm reef; it needs the release and secrets reefs.
nereus nereid apply forgejo \
--reef scm
output
✓ core/nereids/forgejo created, Ready: see 'nereus scm --help'
core/mandates/forgejo created (reef: scm, nereid: forgejo)
Next steps:
nereus scm mirror create <name> --from https://github.com/<owner>/<repository>
mirror-create¶
Copy a public repository, pulled every 10 minutes.
nereus scm mirror create nereus \
--from https://github.com/getnereus/nereus \
--interval 10m
output
✓ scm/mirrors/nereus created (mandate forgejo)
Next steps:
nereus scm mirror get nereus
mirror-list¶
Every Mirror, the commit it holds and its status.
nereus scm mirror list
output
MIRROR FROM MANDATE LAST SYNC COMMIT STATUS
nereus https://github.com/getnereus/nereus forgejo 2026-11-10T12:00:00Z 68d7a0d Ready
outside https://example.com/example/outside forgejo - - SourceUnreachable