Documentation
¶
Overview ¶
Package cli implements the orb commands.
Index ¶
Constants ¶
const JSONSchemaVersion = 1
JSONSchemaVersion is the "schemaVersion" of every orb --json output (ADR-0015, ADR-0054). Scripts check it before reading the rest. Adding a field keeps the version; removing, renaming or retyping one is a breaking change that needs a new major version of orb and a new schema version.
const LockAPIVersion = "gorbital.dev/v2"
LockAPIVersion versions the gorbital.lock format (ADR-0015, ADR-0050).
Variables ¶
var Version = moduleVersion("v0.3.1-dev", debug.ReadBuildInfo)
Version is the orb version. Release builds set it with -ldflags "-X gorbital.dev/cli/internal/cli.Version=v0.2.0"; go install gorbital.dev/cli/cmd/orb@v0.2.0 gets it from the module version. The fallback is what an unstamped build of this tree reports, so it names the release being prepared: it reaches users' apps through gorbital.lock and orb upgrade's branch and commit names.
Functions ¶
func EjectIntoApp ¶ added in v0.2.1
func EjectIntoApp(dir string, modules []recipes.EjectedModule, checkout string) error
EjectIntoApp copies the built-in modules into the app in dir as orb new does after writing a Full app (preset.Ejects), from the gorbital checkout at checkout, and removes the gorbital.lock that records them when the app had none. go generate writes the golden apps with it, so they show what orb new writes; it runs neither go mod tidy nor the surface test.
Types ¶
This section is empty.
Source Files
¶
- add.go
- add_orgs.go
- add_orgs_eject.go
- add_plans.go
- add_rls.go
- add_storage.go
- cli.go
- dev.go
- dev_console.go
- dev_jobs.go
- dev_keys.go
- dev_portal.go
- dev_schema.go
- doctor.go
- doctor_main.go
- doctor_profile.go
- dotenv.go
- eject.go
- explain.go
- gen.go
- gen_middleware.go
- gen_migration.go
- gen_module.go
- gen_modules.go
- gen_plan.go
- gen_resource.go
- gosource.go
- interactive.go
- json.go
- lock.go
- new.go
- new_eject.go
- port.go
- proc_unix.go
- release.go
- routes.go
- security.go
- security_copies.go
- security_names.go
- security_rules.go
- security_sql.go
- style.go
- upgrade.go
- upgrade_layout.go
- upgrade_layout_apply.go
- upgrade_layout_eject.go
- upgrade_layout_module.go
- upgrade_layout_plan.go
- upgrade_layout_routes.go
- upgrade_layout_stack.go
- upgrade_layout_wiring.go