Documentation
¶
Overview ¶
Package cmd implements the `clrk` CLI built on top of cobra.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var RootCmd = &cobra.Command{ Use: "clrk", Short: "CLRK agent sandbox runtime CLI", SilenceUsage: true, SilenceErrors: true, DisableAutoGenTag: true, PersistentPreRunE: func(cmd *cobra.Command, args []string) error { return configureLogging() }, }
RootCmd is the top-level `clrk` command.
Functions ¶
func GenerateDocs ¶
GenerateDocs walks the cobra command tree and writes a single Markdown reference (`clrk.mdx`) under the given directory. The output is shaped for the apoxy-cloud docs2 site: every command becomes a section, and internal cross-references collapse to in-page anchors.
Types ¶
type ComponentState ¶
type ComponentState struct {
Name string `json:"name"`
Status string `json:"status"`
Ready bool `json:"ready"`
Image string `json:"image,omitempty"`
StartedAt string `json:"started_at,omitempty"`
Uptime string `json:"uptime,omitempty"`
}
ComponentState is one row in `clrk dev status`. Source-of-truth varies per component: docker inspect for the k3d server, Pod phase + Ready condition for cm + workers.
type ExposedForward ¶
type ExposedForward struct {
Namespace string `json:"namespace"`
Name string `json:"name"`
HostPort int `json:"host_port"`
ServicePort int32 `json:"service_port"`
}
ExposedForward is one auto-opened host-port forward managed by the `clrk dev` expose reconciler. Mirrored into dev.json on every change so `clrk dev status` can introspect without contacting the cluster.
Source Files
¶
- agents.go
- agents_invocations.go
- agents_logs.go
- agents_run_task.go
- agents_traces.go
- agents_traces_tui.go
- apply.go
- dev.go
- dev_apply.go
- dev_bootstrap.go
- dev_confirm.go
- dev_drift.go
- dev_expose.go
- dev_lock.go
- dev_logs.go
- dev_preflight.go
- dev_push_image.go
- dev_reload.go
- dev_secrets.go
- dev_status.go
- dev_streams.go
- dev_wait_ready.go
- docs.go
- install.go
- kube.go
- pools.go
- root.go
- secret.go
- spinner.go
- upgrade.go
- watch.go
Directories
¶
| Path | Synopsis |
|---|---|
|
Package devagents tracks the live state of TaskAgent and DaemonAgent objects in the dev cluster and rolls up per-agent telemetry from the in-process OTLP receiver.
|
Package devagents tracks the live state of TaskAgent and DaemonAgent objects in the dev cluster and rolls up per-agent telemetry from the in-process OTLP receiver. |
|
Package devotel implements an in-process OTLP/HTTP receiver that `clrk dev` runs to capture egress ext_proc telemetry without having to bundle a real otel-collector container.
|
Package devotel implements an in-process OTLP/HTTP receiver that `clrk dev` runs to capture egress ext_proc telemetry without having to bundle a real otel-collector container. |
|
Package devtui renders the live status of `clrk dev` (agents, k3s, controller-manager, workers) and their per-component logs in a Bubble Tea TUI.
|
Package devtui renders the live status of `clrk dev` (agents, k3s, controller-manager, workers) and their per-component logs in a Bubble Tea TUI. |
|
Package spangraph renders OTLP spans as a lazygit-style hierarchy graph: each trace drawn as a tree by parent/child with colored lanes, a status-colored node per span, a compact metadata tail, and a detail block (attributes plus event bodies) the caller expands or collapses for the whole graph at once via a global expand level.
|
Package spangraph renders OTLP spans as a lazygit-style hierarchy graph: each trace drawn as a tree by parent/child with colored lanes, a status-colored node per span, a compact metadata tail, and a detail block (attributes plus event bodies) the caller expands or collapses for the whole graph at once via a global expand level. |