Directories
¶
| Path | Synopsis |
|---|---|
|
Package auth provides olares-cli's authentication primitives: JWT expiry extraction, password-based login (/api/firstfactor + /api/secondfactor/totp), refresh-token bootstrap (/api/refresh), and the on-disk token store.
|
Package auth provides olares-cli's authentication primitives: JWT expiry extraction, password-based login (/api/firstfactor + /api/secondfactor/totp), refresh-token bootstrap (/api/refresh), and the on-disk token store. |
|
Package bflenvelope decodes the response envelope every `olares-cli settings` route replies with: {code, message, data}.
|
Package bflenvelope decodes the response envelope every `olares-cli settings` route replies with: {code, message, data}. |
|
bootstrap
|
|
|
Package chart ports devbox's docker-compose -> Olares chart scaffolding into olares-cli.
|
Package chart ports devbox's docker-compose -> Olares chart scaffolding into olares-cli. |
|
Package cliconfig owns the on-disk profile configuration of olares-cli (~/.olares-cli/config.json).
|
Package cliconfig owns the on-disk profile configuration of olares-cli (~/.olares-cli/config.json). |
|
Package clierr holds error sentinels that the process entrypoint must understand.
|
Package clierr holds error sentinels that the process entrypoint must understand. |
|
Package cliutil hosts CLI-tree-agnostic helpers shared across the cmd/ctl/* subtrees (settings, cluster, files, dashboard, market).
|
Package cliutil hosts CLI-tree-agnostic helpers shared across the cmd/ctl/* subtrees (settings, cluster, files, dashboard, market). |
|
Package clusterclient is the HTTP wrapper olares-cli's `cluster` command tree uses to talk to the per-user ControlHub BFF (`<rp.ControlHubURL>`).
|
Package clusterclient is the HTTP wrapper olares-cli's `cluster` command tree uses to talk to the per-user ControlHub BFF (`<rp.ControlHubURL>`). |
|
Package clusterctx centralizes the "who am I against this Olares cluster?" round-trip used by `olares-cli cluster context` and by any future verb that wants to render the active profile's identity / role / accessible workspaces from the ControlHub side.
|
Package clusterctx centralizes the "who am I against this Olares cluster?" round-trip used by `olares-cli cluster context` and by any future verb that wants to render the active profile's identity / role / accessible workspaces from the ControlHub side. |
|
Package clusterexec implements the client side of the Kubernetes remote-command (exec) WebSocket subprotocol "v4.channel.k8s.io" used by `olares-cli cluster {pod,container} exec`.
|
Package clusterexec implements the client side of the Kubernetes remote-command (exec) WebSocket subprotocol "v4.channel.k8s.io" used by `olares-cli cluster {pod,container} exec`. |
|
Package cmdutil holds the shared "Factory" that command implementations reach into instead of constructing their own clients / loading their own config / etc.
|
Package cmdutil holds the shared "Factory" that command implementations reach into instead of constructing their own clients / loading their own config / etc. |
|
Package containerdimages is the shared wire model + fetch path for the containerd image list exposed by user-service at /api/containerd/images (a BFL-enveloped array).
|
Package containerdimages is the shared wire model + fetch path for the containerd image list exposed by user-service at /api/containerd/images (a BFL-enveloped array). |
|
Package cookieparse turns the three cookie exchange formats a user can realistically get hold of (Netscape cookies.txt, JSON exports, raw HTTP headers) into the DomainCookie shape user-service stores in Infisical.
|
Package cookieparse turns the three cookie exchange formats a user can realistically get hold of (Netscape cookies.txt, JSON exports, raw HTTP headers) into the DomainCookie shape user-service stores in Infisical. |
|
core
|
|
|
Package credential is the orchestration layer that turns a cliconfig.ProfileConfig + a stored token into a fully-resolved view that command code can consume without touching disk directly.
|
Package credential is the orchestration layer that turns a cliconfig.ProfileConfig + a stored token into a fully-resolved view that command code can consume without touching disk directly. |
|
api
Package api is a thin HTTP client for the local olaresd daemon.
|
Package api is a thin HTTP client for the local olaresd daemon. |
|
state
Package state defines the data types exposed by the local olaresd daemon's GET /system/status endpoint.
|
Package state defines the data types exposed by the local olaresd daemon's GET /system/status endpoint. |
|
Package dashboard hosts the data + transport layer for the `olares-cli dashboard` CLI subtree.
|
Package dashboard hosts the data + transport layer for the `olares-cli dashboard` CLI subtree. |
|
applications
Package applications hosts the business logic for the `olares-cli dashboard applications` cobra leaf — a workload-grain table mirroring the SPA's Applications page.
|
Package applications hosts the business logic for the `olares-cli dashboard applications` cobra leaf — a workload-grain table mirroring the SPA's Applications page. |
|
format
Package format is a 1:1 Go port of the dashboard SPA's number / unit formatting helpers.
|
Package format is a 1:1 Go port of the dashboard SPA's number / unit formatting helpers. |
|
overview
Package overview hosts the business logic for the `olares-cli dashboard overview` cobra subtree — physical / user / ranking / cpu / memory / pods / network leaves plus the default fan-out aggregator.
|
Package overview hosts the business logic for the `olares-cli dashboard overview` cobra subtree — physical / user / ranking / cpu / memory / pods / network leaves plus the default fan-out aggregator. |
|
overview/disk
Package disk hosts the business logic for the `olares-cli dashboard overview disk` subtree (root + main + partitions).
|
Package disk hosts the business logic for the `olares-cli dashboard overview disk` subtree (root + main + partitions). |
|
overview/fan
Package fan hosts the business logic for the `olares-cli dashboard overview fan` subtree (root + live + curve).
|
Package fan hosts the business logic for the `olares-cli dashboard overview fan` subtree (root + live + curve). |
|
overview/gpu
Package gpu hosts the business logic for the `olares-cli dashboard overview gpu` subtree (root + list + tasks + get + task + detail + task-detail).
|
Package gpu hosts the business logic for the `olares-cli dashboard overview gpu` subtree (root + list + tasks + get + task + detail + task-detail). |
|
Package olares contains primitives shared across olares-cli that don't fit into a more specific subpackage.
|
Package olares contains primitives shared across olares-cli that don't fit into a more specific subpackage. |
|
plugins
|
|
|
release
|
|
|
Package systemcomponents describes the Kubernetes workloads that make up an Olares installation and provides the readiness check used to decide whether the system is up.
|
Package systemcomponents describes the Kubernetes workloads that make up an Olares installation and provides the readiness check used to decide whether the system is up. |
|
version
|
|
|
web5
|
|
|
crypto
Package crypto provides the following functionality: * Key Generation: secp256k1, ed25519 * Signing: secp256k1, ed25519 * Verification: secp256k1, ed25519 * A KeyManager abstraction that can be leveraged to manage/use keys (create, sign etc) as desired per the given use case
|
Package crypto provides the following functionality: * Key Generation: secp256k1, ed25519 * Signing: secp256k1, ed25519 * Verification: secp256k1, ed25519 * A KeyManager abstraction that can be leveraged to manage/use keys (create, sign etc) as desired per the given use case |
|
crypto/dsa/eddsa
Package eddsa implements the EdDSA signature schemes as per RFC 8032 https://tools.ietf.org/html/rfc8032.
|
Package eddsa implements the EdDSA signature schemes as per RFC 8032 https://tools.ietf.org/html/rfc8032. |
|
jwk
Package jwk implements a subset of the JSON Web Key spec (https://tools.ietf.org/html/rfc7517)
|
Package jwk implements a subset of the JSON Web Key spec (https://tools.ietf.org/html/rfc7517) |
|
Package whoami centralizes the "who am I on this Olares?" round-trip.
|
Package whoami centralizes the "who am I on this Olares?" round-trip. |
|
frp.go: fetch the public Olares-tunnel (FRP) registry by olaresId.
|
frp.go: fetch the public Olares-tunnel (FRP) registry by olaresId. |
Click to show internal directories.
Click to hide internal directories.