Directories
¶
| Path | Synopsis |
|---|---|
|
Package cli implements the orb commands.
|
Package cli implements the orb commands. |
|
Package devmail is the Dev Portal's mail catcher (ADR-0074): an SMTP server inside orb dev that keeps every message the app sends under .orb/portal/mail, parsed for the inbox screen.
|
Package devmail is the Dev Portal's mail catcher (ADR-0074): an SMTP server inside orb dev that keeps every message the app sends under .orb/portal/mail, parsed for the inbox screen. |
|
Package genplan describes what a generator would write before it writes anything: a plan of file changes that the CLI prints as a dry run, that the Dev Portal shows as a diff to approve, and that Apply writes (ADR-0021, ADR-0066).
|
Package genplan describes what a generator would write before it writes anything: a plan of file changes that the CLI prints as a dry run, that the Dev Portal shows as a diff to approve, and that Apply writes (ADR-0021, ADR-0066). |
|
Package merge plans how orb upgrade and orb add carry template changes into an app the developer has edited: a 3-way merge per file between what orb wrote before (base), what it writes now (theirs) and the file on disk (ours).
|
Package merge plans how orb upgrade and orb add carry template changes into an app the developer has edited: a 3-way merge per file between what orb wrote before (base), what it writes now (theirs) and the file on disk (ours). |
|
Package pgmeta reads a PostgreSQL database's catalog, reads and edits rows, and renders schema changes as goose migrations, for the Dev Portal's Table Editor and Schema pages (ADR-0067).
|
Package pgmeta reads a PostgreSQL database's catalog, reads and edits rows, and renders schema changes as goose migrations, for the Dev Portal's Table Editor and Schema pages (ADR-0067). |
|
Package portal serves the Dev Portal while orb dev runs an app (ADR-0066): the portal's web UI, its own API under /_portal/api/ (the app's state and output, restarts, generators), and a proxy under /_portal/app/ to the app, which adds the dev console token for /_dev/ requests (ADR-0065) so the UI never holds it.
|
Package portal serves the Dev Portal while orb dev runs an app (ADR-0066): the portal's web UI, its own API under /_portal/api/ (the app's state and output, restarts, generators), and a proxy under /_portal/app/ to the app, which adds the dev console token for /_dev/ requests (ADR-0065) so the UI never holds it. |
|
ui
Package ui embeds the built Dev Portal UI: the static export of gorbital-dashboards/apps/devtools, copied into dist/ by scripts/sync-portal.sh and committed (ADR-0066), so go install and release builds carry the same UI; dist/BUILD names the gorbital-dashboards commit.
|
Package ui embeds the built Dev Portal UI: the static export of gorbital-dashboards/apps/devtools, copied into dist/ by scripts/sync-portal.sh and committed (ADR-0066), so go install and release builds carry the same UI; dist/BUILD names the gorbital-dashboards commit. |
|
Package recipes renders the project templates used by orb new.
|
Package recipes renders the project templates used by orb new. |
|
gen
command
Command gen regenerates every preset's recipe templates from its golden app.
|
Command gen regenerates every preset's recipe templates from its golden app. |
|
generate
Package generate converts a hand-written golden app into recipe templates: it replaces the placeholder module path and name, and derives the go.mod template from the golden go.mod (ADR-0041).
|
Package generate converts a hand-written golden app into recipe templates: it replaces the placeholder module path and name, and derives the go.mod template from the golden go.mod (ADR-0041). |
Click to show internal directories.
Click to hide internal directories.