Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
norcube
command
|
|
|
internal
|
|
|
api/apierror
Package apierror renders non-2xx API responses into error messages that are actually useful for debugging.
|
Package apierror renders non-2xx API responses into error messages that are actually useful for debugging. |
|
api/billing
Package billing provides primitives to interact with the openapi HTTP API.
|
Package billing provides primitives to interact with the openapi HTTP API. |
|
api/domainradar
Package domainradar provides primitives to interact with the openapi HTTP API.
|
Package domainradar provides primitives to interact with the openapi HTTP API. |
|
api/langsync
Package langsync provides primitives to interact with the openapi HTTP API.
|
Package langsync provides primitives to interact with the openapi HTTP API. |
|
api/monitor
Package monitor provides primitives to interact with the openapi HTTP API.
|
Package monitor provides primitives to interact with the openapi HTTP API. |
|
api/snapdb
Package snapdb provides primitives to interact with the openapi HTTP API.
|
Package snapdb provides primitives to interact with the openapi HTTP API. |
|
cli/backup
Package backup implements the `norcube backup ...` command tree (snapdb is the backend service behind the Norcube Backup product).
|
Package backup implements the `norcube backup ...` command tree (snapdb is the backend service behind the Norcube Backup product). |
|
cli/billing
Package billing implements the `norcube billing ...` command tree: the organization's account status, subscriptions, usage estimate, invoices and spending caps.
|
Package billing implements the `norcube billing ...` command tree: the organization's account status, subscriptions, usage estimate, invoices and spending caps. |
|
cli/domainradar
Package domainradar implements the `norcube domainradar ...` command tree: domain checks, bulk checks, saved domains, brand monitoring and the name generator.
|
Package domainradar implements the `norcube domainradar ...` command tree: domain checks, bulk checks, saved domains, brand monitoring and the name generator. |
|
cli/langsync
Package langsync implements the `norcube langsync ...` command tree.
|
Package langsync implements the `norcube langsync ...` command tree. |
|
cli/langsync/projectcfg
Package projectcfg loads and writes the per-project Langsync config (`.langsync.json`).
|
Package projectcfg loads and writes the per-project Langsync config (`.langsync.json`). |
|
cli/langsync/projectcfg/translations
Package translations reads and writes language files for the sync command.
|
Package translations reads and writes language files for the sync command. |
|
cli/monitor
Package monitor implements the `norcube monitor ...` command tree: uptime, SSL certificate and domain expiry monitors, their check history, incidents and alert channels, and an organization-wide status for scripts and CI.
|
Package monitor implements the `norcube monitor ...` command tree: uptime, SSL certificate and domain expiry monitors, their check history, incidents and alert channels, and an organization-wide status for scripts and CI. |
|
clictx
Package clictx carries the global per-invocation state (flags, cancellable context) attached to every cobra command, so subcommand packages can read it without importing the root cli package and creating an import cycle.
|
Package clictx carries the global per-invocation state (flags, cancellable context) attached to every cobra command, so subcommand packages can read it without importing the root cli package and creating an import cycle. |
|
clierr
Package clierr holds the CLI's process exit codes and the error types that select them, so scripts can branch on why a command failed.
|
Package clierr holds the CLI's process exit codes and the error types that select them, so scripts can branch on why a command failed. |
|
cmdutil
Package cmdutil is the one path from a command's result to stdout.
|
Package cmdutil is the one path from a command's result to stdout. |
|
completion
Package completion serves dynamic shell completions (organization slugs, namespaces, data source and job ids, language codes) from the API.
|
Package completion serves dynamic shell completions (organization slugs, namespaces, data source and job ids, language codes) from the API. |
|
config
Package config reads and writes the CLI's configuration file.
|
Package config reads and writes the CLI's configuration file. |
|
credstore
Package credstore holds the CLI's secrets: one item per key in the OS keyring, or one 0600 file per key when no keyring is available.
|
Package credstore holds the CLI's secrets: one item per key in the OS keyring, or one 0600 file per key when no keyring is available. |
|
orgs
Package orgs turns what the user typed for --org (an id or a slug) into an organization id the services accept.
|
Package orgs turns what the user typed for --org (an id or a slug) into an organization id the services accept. |
|
output
Package output renders command results in one of four user-selected formats: a human-friendly table, JSON, YAML, or tab-separated text.
|
Package output renders command results in one of four user-selected formats: a human-friendly table, JSON, YAML, or tab-separated text. |
|
registry
Package registry is the CLI's list of Norcube services, read from the embedded services.yaml.
|
Package registry is the CLI's list of Norcube services, read from the embedded services.yaml. |
|
resolve
Package resolve decides which profile, endpoints, organization, credentials and output format one command uses, and remembers where each value came from (for `norcube config list`).
|
Package resolve decides which profile, endpoints, organization, credentials and output format one command uses, and remembers where each value came from (for `norcube config list`). |
|
service
Package service builds the typed API client a command needs, the same way for every Norcube service: it resolves the profile, the target organization, the service endpoint, a token source for the service's audience (from the selected credential store) and the shared HTTP transport.
|
Package service builds the typed API client a command needs, the same way for every Norcube service: it resolves the profile, the target organization, the service endpoint, a token source for the service's audience (from the selected credential store) and the shared HTTP transport. |
|
sse
Package sse reads server-sent event streams (text/event-stream), as the HTML standard defines them, and keeps a stream going across dropped connections.
|
Package sse reads server-sent event streams (text/event-stream), as the HTML standard defines them, and keeps a stream going across dropped connections. |
|
term
Package term decides what the CLI may do with the user's terminal: is a stream a TTY, may it carry color, may we prompt.
|
Package term decides what the CLI may do with the user's terminal: is a stream a TTY, may it carry color, may we prompt. |
|
transport
Package transport builds the one HTTP client every part of the CLI uses: generated API clients, the auth client, the token exchange and artifact downloads.
|
Package transport builds the one HTTP client every part of the CLI uses: generated API clients, the auth client, the token exchange and artifact downloads. |
|
tools
|
|
|
codegen
command
codegen regenerates the typed API clients listed in internal/registry/services.yaml: for every service with a `package`, it converts the Swagger 2.0 spec from the backend monorepo to OpenAPI 3 (specs/<package>.openapi.json) and runs a pinned oapi-codegen with internal/api/<package>/oapi-codegen.yaml.
|
codegen regenerates the typed API clients listed in internal/registry/services.yaml: for every service with a `package`, it converts the Swagger 2.0 spec from the backend monorepo to OpenAPI 3 (specs/<package>.openapi.json) and runs a pinned oapi-codegen with internal/api/<package>/oapi-codegen.yaml. |
|
gendocs
command
Command gendocs turns the CLI's help text into documentation, so the command tree is the only place flags and examples are written down.
|
Command gendocs turns the CLI's help text into documentation, so the command tree is the only place flags and examples are written down. |
|
swagger2openapi
command
swagger2openapi reads a Swagger 2.0 JSON document and writes the equivalent OpenAPI 3.0 JSON to stdout.
|
swagger2openapi reads a Swagger 2.0 JSON document and writes the equivalent OpenAPI 3.0 JSON to stdout. |
Click to show internal directories.
Click to hide internal directories.
