Help us shape the future of Go! Take the 2026 Go Developer Survey

cli

module
v0.3.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 23, 2026 License: Apache-2.0

Directories

Path Synopsis
cmd
orb command
The orb command creates and runs gorbital applications.
The orb command creates and runs gorbital applications.
internal
cli
Package cli implements the orb commands.
Package cli implements the orb commands.
devmail
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.
genplan
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).
imports
Package imports changes the import paths of Go files, keeping everything else byte for byte.
Package imports changes the import paths of Go files, keeping everything else byte for byte.
merge
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).
pgmeta
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).
portal
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.
portal/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.
recipes
Package recipes renders the project templates used by orb new.
Package recipes renders the project templates used by orb new.
recipes/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.
recipes/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).
routes
Package routes lists an app's HTTP routes for orb routes and the Dev Portal (ADR-0082, ADR-0083): what each route is, from the app's OpenAPI document (method, path, operation ID, summary, tags, guards from x-gorbital-guards, whether it is public), joined with where it is in the app's source, found with go/parser (the registration's file and line, the handler and its declaration, the module, and the middleware gorbital.Use and Module.Middleware add).
Package routes lists an app's HTTP routes for orb routes and the Dev Portal (ADR-0082, ADR-0083): what each route is, from the app's OpenAPI document (method, path, operation ID, summary, tags, guards from x-gorbital-guards, whether it is public), joined with where it is in the app's source, found with go/parser (the registration's file and line, the handler and its declaration, the module, and the middleware gorbital.Use and Module.Middleware add).
tunnel
Package tunnel runs the developer's cloudflared for orb dev (ADR-0086): a quick tunnel (a random *.trycloudflare.com URL, no account) or a named tunnel (the developer's hostname, with the token from .env), exposing the app, and only the app, on a public HTTPS address.
Package tunnel runs the developer's cloudflared for orb dev (ADR-0086): a quick tunnel (a random *.trycloudflare.com URL, no account) or a named tunnel (the developer's hostname, with the token from .env), exposing the app, and only the app, on a public HTTPS address.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL