cli

package

v0.6.3 Latest Latest Go to latest Published: May 31, 2026 License: Apache-2.0 Imports: 47 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/orkspace/orkestra

Links

Open Source Insights

README ¶

cmd/cli

CLI command definitions for the ork binary. Each file registers one command or sub-command with the root Cobra command.

Entry points

Command	File	What it does
`ork run`	`run.go` / `run_dev.go`	Start the runtime (reconcile loop)
`ork gate`	`gateway.go`	Start the gateway (TLS + webhooks, cluster-only)
`ork generate`	`generate.go`	Generate RBAC, bundles, ConfigMaps, CRDs, docs
`ork validate`	`validate.go`	Validate a Katalog file
`ork deploy`	`deploy.go`	Deploy an operator via `ork doctor`
`ork plan`	`plan.go`	Dry-run a Katalog against a live cluster

For the full command reference see documentation/reference/cli.

Design docs

build-tags.md — how //go:build runtime and //go:build gateway control which sub-commands ship in each image

Documentation ¶

Index ¶

Variables
func Execute(k *konfig.Konfig, c context.Context)
func StartSpinner(msg string) *spinner.Spinner
type Pack
- func GetPack(name string) (Pack, bool)
- func ListPacks() []Pack
- func (p Pack) String() string

Constants ¶

This section is empty.

Variables ¶

View Source

var Packs = map[string]Pack{
	"beginner": {
		Name:        "beginner",
		Description: "Start here. Simple CRDs, Deployments, Services.",
		Path:        "beginner",
	},
	"intermediate": {
		Name:        "intermediate",
		Description: "Multi-resource patterns, when/anyOf, Komposer basics.",
		Path:        "intermediate",
	},
	"advanced": {
		Name:        "advanced",
		Description: "Hooks, constructors, validation/mutation, registries.",
		Path:        "advanced",
	},
	"security": {
		Name:        "security",
		Description: "Deletion protection, namespace protection, admission webhooks.",
		Path:        "security",
	},
	"use-cases": {
		Name:        "use-cases",
		Description: "Full-stack, cross-CRD, external gates, once-secrets.",
		Path:        "use-cases",
	},
}

Functions ¶

func Execute ¶

func Execute(k *konfig.Konfig, c context.Context)

func StartSpinner ¶ added in v0.4.8

func StartSpinner(msg string) *spinner.Spinner

StartSpinner starts a terminal progress spinner with the given message. Call Success, Failure, or Stop on the returned value when done.

Types ¶

type Pack ¶ added in v0.3.8

type Pack struct {
	Name        string
	Description string
	Path        string
}

packPaths maps CLI pack names to their paths inside the embedded FS. Most packs are top-level directories; rollback is nested under use-cases.

func GetPack ¶ added in v0.3.8

func GetPack(name string) (Pack, bool)

func ListPacks ¶ added in v0.3.8

func ListPacks() []Pack

func (Pack) String ¶ added in v0.5.1

func (p Pack) String() string

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