Directories
¶
| Path | Synopsis |
|---|---|
|
Package apicall is the raw request behind `pgedge starfleet api` and `pgedge controlplane api`: one HTTP call to a path under the module's API base, over the module's own authenticated client, with the module's own status-to-exit mapping and the CLI's output formats.
|
Package apicall is the raw request behind `pgedge starfleet api` and `pgedge controlplane api`: one HTTP call to a path under the module's API base, over the module's own authenticated client, with the module's own status-to-exit mapping and the CLI's output formats. |
|
Package apidefaults owns platform-level API defaults: the pgEdge Starfleet base URL and its resolution rule (flag > profile > default).
|
Package apidefaults owns platform-level API defaults: the pgEdge Starfleet base URL and its resolution rule (flag > profile > default). |
|
Package atomicfile replaces a file in one step, so a reader arriving mid-write sees the whole old file or the whole new one and never a truncated one.
|
Package atomicfile replaces a file in one step, so a reader arriving mid-write sees the whole old file or the whole new one and never a truncated one. |
|
Package auth resolves API credentials and manages cached access tokens per profile and module under ~/.pgedge/cli/cache/.
|
Package auth resolves API credentials and manages cached access tokens per profile and module under ~/.pgedge/cli/cache/. |
|
Package clitest assembles the full pgedge command tree for build-gate tests.
|
Package clitest assembles the full pgedge command tree for build-gate tests. |
|
Package config loads and saves the pgedge CLI configuration at ~/.pgedge/cli/config.yaml with named profiles carrying per-module sections.
|
Package config loads and saves the pgedge CLI configuration at ~/.pgedge/cli/config.yaml with named profiles carrying per-module sections. |
|
Package controlplane implements the pgEdge Control Plane module of the unified pgedge CLI.
|
Package controlplane implements the pgEdge Control Plane module of the unified pgedge CLI. |
|
api
Package api provides primitives to interact with the openapi HTTP API.
|
Package api provides primitives to interact with the openapi HTTP API. |
|
cmd
Package cmd wires the pgEdge Control Plane command tree: the module root, its persistent connection flags, and the HTTP API client shared by every resource command.
|
Package cmd wires the pgEdge Control Plane command tree: the module root, its persistent connection flags, and the HTTP API client shared by every resource command. |
|
svccfg
Package svccfg is a hand-written mirror of the Control Plane's per-service-type config key sets (mcp, rag, postgrest) at the CP release KeysFloor names.
|
Package svccfg is a hand-written mirror of the Control Plane's per-service-type config key sets (mcp, rag, postgrest) at the CP release KeysFloor names. |
|
Package docgen renders the command reference, the llms pages and the docs/reference pages, from the live cobra tree.
|
Package docgen renders the command reference, the llms pages and the docs/reference pages, from the live cobra tree. |
|
Package dotenv sets one variable in a .env file, leaving every other line as it was.
|
Package dotenv sets one variable in a .env file, leaving every other line as it was. |
|
Package dryrun records what a mutating command WOULD have sent, and stops it from being sent.
|
Package dryrun records what a mutating command WOULD have sent, and stops it from being sent. |
|
Package errbody repairs one specific lie an upstream proxy tells: an error response whose body is not JSON, served under a JSON Content-Type.
|
Package errbody repairs one specific lie an upstream proxy tells: an error response whose body is not JSON, served under a JSON Content-Type. |
|
Package httplog renders HTTP requests and responses to a diagnostic stream at an ordered level, and is the one place in this CLI that decides what must never be printed.
|
Package httplog renders HTTP requests and responses to a diagnostic stream at an ordered level, and is the one place in this CLI that decides what must never be printed. |
|
Package inspect runs read-only diagnostic queries against a Postgres database and renders the rows.
|
Package inspect runs read-only diagnostic queries against a Postgres database and renders the rows. |
|
inspecttest
Package inspecttest is a database/sql driver that answers queries from a script, so a command that runs an inspect analysis can be tested without a Postgres.
|
Package inspecttest is a database/sql driver that answers queries from a script, so a command that runs an inspect analysis can be tested without a Postgres. |
|
Package keychain stores the Starfleet client secret in the operating system's credential store: macOS Keychain, the Secret Service on Linux, Credential Manager on Windows.
|
Package keychain stores the Starfleet client secret in the operating system's credential store: macOS Keychain, the Secret Service on Linux, Credential Manager on Windows. |
|
Package metricfmt renders metric samples for text tables.
|
Package metricfmt renders metric samples for text tables. |
|
Package module defines the contract between the base pgedge CLI and its modules.
|
Package module defines the contract between the base pgedge CLI and its modules. |
|
Package projectlink reads and writes .pgedge/link.yaml, the file that ties a project folder to one database.
|
Package projectlink reads and writes .pgedge/link.yaml, the file that ties a project folder to one database. |
|
Package reference derives a module's reference pages from the files it embeds, and answers the routing questions `pgedge llms` and the generator ask of them.
|
Package reference derives a module's reference pages from the files it embeds, and answers the routing questions `pgedge llms` and the generator ask of them. |
|
Package selfupdate implements `pgedge self update`: resolving a release tag from a fetched release list, verifying the downloaded asset, and swapping it into place.
|
Package selfupdate implements `pgedge self update`: resolving a release tag from a fetched release list, verifying the downloaded asset, and swapping it into place. |
|
Package starfleet is the pgEdge Starfleet module: one product, one connection, three faces (account-level resources, byoc, managed).
|
Package starfleet is the pgEdge Starfleet module: one product, one connection, three faces (account-level resources, byoc, managed). |
|
account/api
Package api provides primitives to interact with the openapi HTTP API.
|
Package api provides primitives to interact with the openapi HTTP API. |
|
account/cmd
Package cmd wires the account-level commands of the pgedge starfleet tree: authentication, API clients, tenants, invites and memberships — everything the accounts half of the Starfleet API owns.
|
Package cmd wires the account-level commands of the pgedge starfleet tree: authentication, API clients, tenants, invites and memberships — everything the accounts half of the Starfleet API owns. |
|
byoc
Package byoc holds the byoc sub-tree of the starfleet module: its generated API client, its command tree and its reference pages.
|
Package byoc holds the byoc sub-tree of the starfleet module: its generated API client, its command tree and its reference pages. |
|
byoc/api
Package api provides primitives to interact with the openapi HTTP API.
|
Package api provides primitives to interact with the openapi HTTP API. |
|
byoc/cmd
Package cmd wires the pgEdge BYOC command tree: the module root, its persistent flags, and the authenticated API client shared by every resource command.
|
Package cmd wires the pgEdge BYOC command tree: the module root, its persistent flags, and the authenticated API client shared by every resource command. |
|
cmd
Package cmd wires the pgedge starfleet command tree: the starfleet root, its persistent connection flags, the account-level commands (auth, doctor, tenant, client, invite, membership), and the byoc and managed sub-trees.
|
Package cmd wires the pgedge starfleet command tree: the starfleet root, its persistent connection flags, the account-level commands (auth, doctor, tenant, client, invite, membership), and the byoc and managed sub-trees. |
|
conn
Package conn owns the single pgEdge Starfleet API connection: base-URL and credential precedence, the token exchange and cache, the shared HTTP client, and the exit codes every Starfleet module reports.
|
Package conn owns the single pgEdge Starfleet API connection: base-URL and credential precedence, the token exchange and cache, the shared HTTP client, and the exit codes every Starfleet module reports. |
|
connstr
Package connstr assembles a libpq connection string from the parts a database GET returns, for the managed and byoc connection-string verbs.
|
Package connstr assembles a libpq connection string from the parts a database GET returns, for the managed and byoc connection-string verbs. |
|
managed
Package managed holds the managed sub-tree of the starfleet module: its generated API client, its command tree and its reference pages.
|
Package managed holds the managed sub-tree of the starfleet module: its generated API client, its command tree and its reference pages. |
|
managed/api
Package api provides primitives to interact with the openapi HTTP API.
|
Package api provides primitives to interact with the openapi HTTP API. |
|
managed/cmd
Package cmd wires the pgEdge Managed command tree: the module root, its persistent flags, and the authenticated API client shared by every resource command.
|
Package cmd wires the pgEdge Managed command tree: the module root, its persistent flags, and the authenticated API client shared by every resource command. |
|
Package testsupport holds the test fixtures every Starfleet module's command tree needs: an isolated Runtime, the stub token/resource server, and the authenticated-command runner.
|
Package testsupport holds the test fixtures every Starfleet module's command tree needs: an isolated Runtime, the stub token/resource server, and the authenticated-command runner. |
Click to show internal directories.
Click to hide internal directories.