# Nereus { .home-title }

A composable API platform: **reefs add the APIs, Nereids look after them, installed at runtime**. An Internal Developer Platform is one profile of it.
{ .home-lead }

[Install the CLI](start/install.md){ .md-button .md-button--primary }

<div class="grid cards home-cards" markdown>

-   :material-play-circle-outline: **[Start](start/install.md)**

    From nothing to a reef and its Nereid, in six short steps.

-   :material-lightbulb-outline: **[Concepts](concepts/model.md)**

    Reef, Nereid and Mandate: the model in a few pages.

-   :material-tools: **[Guides](guides/reefs/secrets.md)**

    One goal per page: install, operate, grant access, use a reef.

-   :material-book-open-outline: **[Reference](reference/glossary.md)**

    Every command, every reef, every word.

</div>

<!-- diagram:overview:start (scripts/docs/diagrams) -->
<figure class="diagram overview" markdown="0">
<svg class="rh wide" viewBox="0 0 960 540" role="img" aria-label="Nereus as a stack: the IDE, the CLI, the portal and agents use the Nereus API; under it, five planes of reefs (developer, delivery, resources, observability, security) make the control plane; the data plane is where it runs."><path class="ln" d="M162,2 H150 V46 H162"/><line class="ln" x1="132" y1="24" x2="150" y2="24"/><text class="b" x="126" y="29" text-anchor="end">Clients</text><rect class="actor" x="170" y="0" width="191.5" height="48"/><text class="b" x="265.75" y="30" text-anchor="middle">IDE</text><rect class="actor" x="369.5" y="0" width="191.5" height="48"/><text class="b" x="465.25" y="30" text-anchor="middle">CLI</text><rect class="actor" x="569" y="0" width="191.5" height="48"/><text class="b" x="664.75" y="30" text-anchor="middle">Portal</text><rect class="actor" x="768.5" y="0" width="191.5" height="48"/><text class="b" x="864.25" y="30" text-anchor="middle">Agents</text><rect class="col" x="170" y="58" width="790" height="52"/><text class="b" x="190" y="90" text-anchor="start">Nereus API</text><text class="s" x="310" y="90" text-anchor="start">(every client, one door; each column is a reef, looked after by its Nereids)</text><rect class="col" x="170" y="120" width="150" height="300"/><text class="b" x="184" y="148" text-anchor="start">Developer</text><text class="s" x="184" y="168" text-anchor="start">(where apps start)</text><rect class="card" x="180" y="182" width="130" height="226"/><text class="s" x="192" y="208" text-anchor="start">Catalog</text><line class="sep" x1="192" y1="222" x2="298" y2="222"/><text class="s" x="192" y="246" text-anchor="start">Portal</text><line class="sep" x1="192" y1="260" x2="298" y2="260"/><rect class="col" x="330" y="120" width="150" height="300"/><text class="b" x="344" y="148" text-anchor="start">Delivery</text><text class="s" x="344" y="168" text-anchor="start">(code to running)</text><rect class="card" x="340" y="182" width="130" height="226"/><text class="s" x="352" y="208" text-anchor="start">SCM</text><line class="sep" x1="352" y1="222" x2="458" y2="222"/><text class="s" x="352" y="246" text-anchor="start">Build</text><line class="sep" x1="352" y1="260" x2="458" y2="260"/><text class="s" x="352" y="284" text-anchor="start">Registry</text><line class="sep" x1="352" y1="298" x2="458" y2="298"/><text class="s" x="352" y="322" text-anchor="start">Release</text><line class="sep" x1="352" y1="336" x2="458" y2="336"/><text class="s" x="352" y="360" text-anchor="start">Delivery</text><line class="sep" x1="352" y1="374" x2="458" y2="374"/><rect class="col" x="490" y="120" width="150" height="300"/><text class="b" x="504" y="148" text-anchor="start">Resources</text><text class="s" x="504" y="168" text-anchor="start">(what apps use)</text><rect class="card" x="500" y="182" width="130" height="226"/><text class="s" x="512" y="208" text-anchor="start">Environment</text><line class="sep" x1="512" y1="222" x2="618" y2="222"/><text class="s" x="512" y="246" text-anchor="start">Database</text><line class="sep" x1="512" y1="260" x2="618" y2="260"/><text class="s" x="512" y="284" text-anchor="start">Messaging</text><line class="sep" x1="512" y1="298" x2="618" y2="298"/><text class="s" x="512" y="322" text-anchor="start">Edge</text><line class="sep" x1="512" y1="336" x2="618" y2="336"/><rect class="col" x="650" y="120" width="150" height="300"/><text class="b" x="664" y="148" text-anchor="start">Observability</text><text class="s" x="664" y="168" text-anchor="start">(what happens)</text><rect class="card" x="660" y="182" width="130" height="226"/><text class="s" x="672" y="208" text-anchor="start">Metrics</text><line class="sep" x1="672" y1="222" x2="778" y2="222"/><text class="s" x="672" y="246" text-anchor="start">Usage</text><line class="sep" x1="672" y1="260" x2="778" y2="260"/><rect class="col" x="810" y="120" width="150" height="300"/><text class="b" x="824" y="148" text-anchor="start">Security</text><text class="s" x="824" y="168" text-anchor="start">(who does what)</text><rect class="card" x="820" y="182" width="130" height="226"/><text class="s" x="832" y="208" text-anchor="start">Secrets</text><line class="sep" x1="832" y1="222" x2="938" y2="222"/><text class="s" x="832" y="246" text-anchor="start">Authentication</text><line class="sep" x1="832" y1="260" x2="938" y2="260"/><text class="s" x="832" y="284" text-anchor="start">Authorization</text><line class="sep" x1="832" y1="298" x2="938" y2="298"/><text class="s" x="832" y="322" text-anchor="start">Tenancy</text><line class="sep" x1="832" y1="336" x2="938" y2="336"/><text class="s" x="832" y="360" text-anchor="start">Teams</text><line class="sep" x1="832" y1="374" x2="938" y2="374"/><path class="ln" d="M162,58 H150 V420 H162"/><line class="ln" x1="132" y1="239" x2="150" y2="239"/><text class="b" x="126" y="244" text-anchor="end">Control plane</text><rect class="actor" x="170" y="434" width="790" height="44"/><text class="b" x="190" y="462" text-anchor="start">Environments</text><text class="s" x="310" y="462" text-anchor="start">(Workloads, databases, message streams, routes)</text><rect class="actor" x="170" y="486" width="150" height="44"/><text class="s" x="245" y="514" text-anchor="middle">k3d</text><rect class="actor" x="330" y="486" width="150" height="44"/><text class="s" x="405" y="514" text-anchor="middle">vcluster</text><rect class="actor" x="490" y="486" width="150" height="44"/><text class="s" x="565" y="514" text-anchor="middle">A cloud cluster</text><rect class="actor" x="650" y="486" width="150" height="44"/><text class="s" x="725" y="514" text-anchor="middle">Cloudflare</text><rect class="actor" x="810" y="486" width="150" height="44"/><text class="s" x="885" y="514" text-anchor="middle">GitHub</text><path class="ln" d="M162,434 H150 V530 H162"/><line class="ln" x1="132" y1="482" x2="150" y2="482"/><text class="b" x="126" y="487" text-anchor="end">Data plane</text></svg>
<svg class="rh narrow" viewBox="0 0 360 794" role="img" aria-label="Nereus as a stack: the IDE, the CLI, the portal and agents use the Nereus API; under it, five planes of reefs (developer, delivery, resources, observability, security) make the control plane; the data plane is where it runs."><text class="cap" x="0" y="14" text-anchor="start">CLIENTS</text><rect class="actor" x="0" y="24" width="174" height="40"/><text class="b" x="87" y="50" text-anchor="middle">IDE</text><rect class="actor" x="186" y="24" width="174" height="40"/><text class="b" x="273" y="50" text-anchor="middle">CLI</text><rect class="actor" x="0" y="72" width="174" height="40"/><text class="b" x="87" y="98" text-anchor="middle">Portal</text><rect class="actor" x="186" y="72" width="174" height="40"/><text class="b" x="273" y="98" text-anchor="middle">Agents</text><text class="cap" x="0" y="140" text-anchor="start">CONTROL PLANE</text><rect class="col" x="0" y="150" width="360" height="62"/><text class="b" x="12" y="174" text-anchor="start">Nereus API</text><text class="s" x="12" y="194" text-anchor="start">every client, one door</text><rect class="col" x="0" y="220" width="360" height="54"/><text class="b" x="12" y="242" text-anchor="start">Developer</text><text class="m" x="348" y="242" text-anchor="end">(where apps start)</text><text class="s" x="12" y="264" text-anchor="start">Catalog, Portal</text><rect class="col" x="0" y="282" width="360" height="54"/><text class="b" x="12" y="304" text-anchor="start">Delivery</text><text class="m" x="348" y="304" text-anchor="end">(code to running)</text><text class="s" x="12" y="326" text-anchor="start">SCM, Build, Registry, Release, Delivery</text><rect class="col" x="0" y="344" width="360" height="54"/><text class="b" x="12" y="366" text-anchor="start">Resources</text><text class="m" x="348" y="366" text-anchor="end">(what apps use)</text><text class="s" x="12" y="388" text-anchor="start">Environment, Database, Messaging, Edge</text><rect class="col" x="0" y="406" width="360" height="54"/><text class="b" x="12" y="428" text-anchor="start">Observability</text><text class="m" x="348" y="428" text-anchor="end">(what happens)</text><text class="s" x="12" y="450" text-anchor="start">Metrics, Usage</text><rect class="col" x="0" y="468" width="360" height="72"/><text class="b" x="12" y="490" text-anchor="start">Security</text><text class="m" x="348" y="490" text-anchor="end">(who does what)</text><text class="s" x="12" y="512" text-anchor="start">Secrets, Authentication, Authorization,</text><text class="s" x="12" y="530" text-anchor="start">Tenancy, Teams</text><text class="cap" x="0" y="570" text-anchor="start">DATA PLANE</text><rect class="actor" x="0" y="580" width="360" height="62"/><text class="b" x="12" y="604" text-anchor="start">Environments</text><text class="s" x="12" y="624" text-anchor="start">Workloads, databases, message streams, routes</text><rect class="actor" x="0" y="650" width="174" height="40"/><text class="s" x="87" y="676" text-anchor="middle">k3d</text><rect class="actor" x="186" y="650" width="174" height="40"/><text class="s" x="273" y="676" text-anchor="middle">vcluster</text><rect class="actor" x="0" y="698" width="174" height="40"/><text class="s" x="87" y="724" text-anchor="middle">A cloud cluster</text><rect class="actor" x="186" y="698" width="174" height="40"/><text class="s" x="273" y="724" text-anchor="middle">Cloudflare</text><rect class="actor" x="0" y="746" width="174" height="40"/><text class="s" x="87" y="772" text-anchor="middle">GitHub</text></svg>
</figure>
<!-- diagram:overview:end -->
