Directories
¶
| Path | Synopsis |
|---|---|
|
Package access implements the business logic behind `nself access grant / revoke / list` — managing SSH public keys in the authorized_keys file of an already-deployed nself host.
|
Package access implements the business logic behind `nself access grant / revoke / list` — managing SSH public keys in the authorized_keys file of an already-deployed nself host. |
|
Package admin provides admin dashboard support: audit logging, ACL, multi-project management, and remote connect helpers.
|
Package admin provides admin dashboard support: audit logging, ACL, multi-project management, and remote connect helpers. |
|
Package aiprofile implements AI_PROFILE enforcement, budget caps, feature flags, per-tier timeouts, and rate-limit coordination.
|
Package aiprofile implements AI_PROFILE enforcement, budget caps, feature flags, per-tier timeouts, and rate-limit coordination. |
|
Package apidocs generates an OpenAPI 3.1 spec from the Hasura introspection result and any registered plugin REST routes.
|
Package apidocs generates an OpenAPI 3.1 spec from the Hasura introspection result and any registered plugin REST routes. |
|
Package auth — HTTP client for nSelf auth server operations.
|
Package auth — HTTP client for nSelf auth server operations. |
|
Package backup provides path validation helpers for backup operations.
|
Package backup provides path validation helpers for backup operations. |
|
destinations
Package destinations implements remote backup destination drivers for nSelf's PITR (Point-in-Time Recovery) system.
|
Package destinations implements remote backup destination drivers for nSelf's PITR (Point-in-Time Recovery) system. |
|
pitr
Package pitr implements point-in-time recovery via pg_basebackup and WAL archiving.
|
Package pitr implements point-in-time recovery via pg_basebackup and WAL archiving. |
|
Package build — alertmanager.go: Build-pipeline integration for the Alertmanager routing config, with ɳSentry-aware receiver + route generation.
|
Package build — alertmanager.go: Build-pipeline integration for the Alertmanager routing config, with ɳSentry-aware receiver + route generation. |
|
Package bundle implements the canonical nSelf paid plugin bundle catalog plus install/remove orchestration with license validation, version pinning, and atomic rollback on failure (S2.T03/T04/T22).
|
Package bundle implements the canonical nSelf paid plugin bundle catalog plus install/remove orchestration with license validation, version pinning, and atomic rollback on failure (S2.T03/T04/T22). |
|
cmd
|
|
|
ci
Package ci — serve.go
|
Package ci — serve.go |
|
Package compose: service toggle helper.
|
Package compose: service toggle helper. |
|
monitoring
Package monitoring — alert rule and Alertmanager config generators.
|
Package monitoring — alert rule and Alertmanager config generators. |
|
Package config — user-level telemetry preference management.
|
Package config — user-level telemetry preference management. |
|
Package controlplane implements the shared control-plane core consumed by both the nSelf CLI and the nSelf Admin companion.
|
Package controlplane implements the shared control-plane core consumed by both the nSelf CLI and the nSelf Admin companion. |
|
sim
Package sim provides a multi-server Docker sshd simulation harness for integration-testing the control-plane pipeline without touching live hosts.
|
Package sim provides a multi-server Docker sshd simulation harness for integration-testing the control-plane pipeline without touching live hosts. |
|
Package cost implements per-service cost alerting for nSelf AI and media plugins.
|
Package cost implements per-service cost alerting for nSelf AI and media plugins. |
|
Package database — drill.go: high-level DR drill orchestration.
|
Package database — drill.go: high-level DR drill orchestration. |
|
Package deploy provides deployment management for the nSelf CLI.
|
Package deploy provides deployment management for the nSelf CLI. |
|
bluegreen
Package bluegreen implements zero-downtime blue/green and canary deploys for the nSelf CLI (B47 + B48).
|
Package bluegreen implements zero-downtime blue/green and canary deploys for the nSelf CLI (B47 + B48). |
|
Package deprecation — G4: sunset date computation for per-plugin API entries.
|
Package deprecation — G4: sunset date computation for per-plugin API entries. |
|
S77-T08: doctor --deep check for orphaned Hasura remote schemas.
|
S77-T08: doctor --deep check for orphaned Hasura remote schemas. |
|
Package domain provides DNS propagation polling and nginx server block generation for custom domain provisioning.
|
Package domain provides DNS propagation polling and nginx server block generation for custom domain provisioning. |
|
Package embedded provides the wasmtime + pglite embedded-PostgreSQL path for nSelf stacks that run without an external Postgres container.
|
Package embedded provides the wasmtime + pglite embedded-PostgreSQL path for nSelf stacks that run without an external Postgres container. |
|
Package env implements multi-environment management for nSelf projects.
|
Package env implements multi-environment management for nSelf projects. |
|
Package errs is the sole home for structured, user-facing CLI errors and the process exit-code contract for the nSelf CLI.
|
Package errs is the sole home for structured, user-facing CLI errors and the process exit-code contract for the nSelf CLI. |
|
Package featureflags provides a built-in, file-backed feature flag registry for the nSelf CLI binary.
|
Package featureflags provides a built-in, file-backed feature flag registry for the nSelf CLI binary. |
|
Package generate provides the schema codegen engine for nself generate.
|
Package generate provides the schema codegen engine for nself generate. |
|
Package hasura provides the single step-function entry point that wires Hasura metadata application into the nself lifecycle (start/deploy), so that `<project>/hasura/metadata/` on disk is never silently ignored.
|
Package hasura provides the single step-function entry point that wires Hasura metadata application into the nself lifecycle (start/deploy), so that `<project>/hasura/metadata/` on disk is never silently ignored. |
|
Package health provides health checking utilities for nSelf services.
|
Package health provides health checking utilities for nSelf services. |
|
Package httptimeout provides timeout-bounded *http.Client values per scope.
|
Package httptimeout provides timeout-bounded *http.Client values per scope. |
|
Package infra provides a thin wrapper around the Terraform CLI for provisioning nSelf infrastructure via provider-specific modules (B51/B52).
|
Package infra provides a thin wrapper around the Terraform CLI for provisioning nSelf infrastructure via provider-specific modules (B51/B52). |
|
Package installer provides automated installation of Ollama and related local-LLM infrastructure for nSelf Block A (Zero-Config AI).
|
Package installer provides automated installation of Ollama and related local-LLM infrastructure for nSelf Block A (Zero-Config AI). |
|
Package installmeta persists install-time metadata to ~/.nself/install-meta.json.
|
Package installmeta persists install-time metadata to ~/.nself/install-meta.json. |
|
Package license — banner.go provides warning banner text for grace period states.
|
Package license — banner.go provides warning banner text for grace period states. |
|
Package maintenance — daily Hasura metadata backup cron registration.
|
Package maintenance — daily Hasura metadata backup cron registration. |
|
Package metrics emits Prometheus-compatible metrics for one-shot nSelf CLI command invocations (backup.go: backup/verify results; license.go: license grace-period state; stripe.go: webhook processing outcomes) by writing node_exporter textfile-collector .prom files rather than serving a live /metrics endpoint.
|
Package metrics emits Prometheus-compatible metrics for one-shot nSelf CLI command invocations (backup.go: backup/verify results; license.go: license grace-period state; stripe.go: webhook processing outcomes) by writing node_exporter textfile-collector .prom files rather than serving a live /metrics endpoint. |
|
Package migrate provides migration helpers for legacy nSelf project layouts.
|
Package migrate provides migration helpers for legacy nSelf project layouts. |
|
firebase
Package firebase implements the Firebase → nSelf migration scaffold.
|
Package firebase implements the Firebase → nSelf migration scaffold. |
|
supabase
Package supabase implements the Supabase → nSelf migration pipeline.
|
Package supabase implements the Supabase → nSelf migration pipeline. |
|
Package migrationai provides AST-based schema delta detection and AI-assisted SQL migration generation for nSelf projects.
|
Package migrationai provides AST-based schema delta detection and AI-assisted SQL migration generation for nSelf projects. |
|
Package model detects which plugin distribution model is in effect for a given plugin in the current project: Model A (Docker compose-managed, source under plugins-pro-src/) or Model B (single-binary, installed under ~/.nself/plugins/<name>/).
|
Package model detects which plugin distribution model is in effect for a given plugin in the current project: Model A (Docker compose-managed, source under plugins-pro-src/) or Model B (single-binary, installed under ~/.nself/plugins/<name>/). |
|
Package nginx provides Nginx configuration generation and management for the nSelf CLI.
|
Package nginx provides Nginx configuration generation and management for the nSelf CLI. |
|
Package nginxtopo resolves on-disk nginx directory topology for projects fronted by another stack's nginx (NGINX_FRONTED_BY / config.NginxConfig.
|
Package nginxtopo resolves on-disk nginx directory topology for projects fronted by another stack's nginx (NGINX_FRONTED_BY / config.NginxConfig. |
|
Package oauth provides manual OAuth token refresh helpers.
|
Package oauth provides manual OAuth token refresh helpers. |
|
Package observability instruments long-running nSelf Go services (the embedded servers behind `nself admin`, plugin daemons, and any process that stays up long enough to be scraped) with a live Prometheus registry, an HTTP /metrics endpoint, OpenTelemetry tracing, structured JSON logging, and request/field redaction.
|
Package observability instruments long-running nSelf Go services (the embedded servers behind `nself admin`, plugin daemons, and any process that stays up long enough to be scraped) with a live Prometheus registry, an HTTP /metrics endpoint, OpenTelemetry tracing, structured JSON logging, and request/field redaction. |
|
Package onboarding implements the 6-stage onboarding funnel check for nself doctor --install-check.
|
Package onboarding implements the 6-stage onboarding funnel check for nself doctor --install-check. |
|
Package plugin — lifecycle audit helpers.
|
Package plugin — lifecycle audit helpers. |
|
count
Package count is the CLI's single source for "how many plugins are there".
|
Package count is the CLI's single source for "how many plugins are there". |
|
lifecycle
Package lifecycle provides the dormant-plugin state machine for the nSelf plugin license lifecycle.
|
Package lifecycle provides the dormant-plugin state machine for the nSelf plugin license lifecycle. |
|
scaffold
Package scaffold provides the canonical plugin scaffolding logic shared between the nself CLI (plugin new command) and the standalone new-plugin binary in plugin-sdk-go/devkit.
|
Package scaffold provides the canonical plugin scaffolding logic shared between the nself CLI (plugin new command) and the standalone new-plugin binary in plugin-sdk-go/devkit. |
|
Package ports provides port-holder identification utilities for the nSelf CLI.
|
Package ports provides port-holder identification utilities for the nSelf CLI. |
|
Package promote implements staging-to-production promotion with diff preview and rollback.
|
Package promote implements staging-to-production promotion with diff preview and rollback. |
|
Package repoqa holds repository-wide invariant tests: formatting, layout, and code-rule gates that apply to the whole tree rather than to one package.
|
Package repoqa holds repository-wide invariant tests: formatting, layout, and code-rule gates that apply to the whole tree rather than to one package. |
|
Package runbook implements the SRE runbook library and claw-ops auto-execution engine.
|
Package runbook implements the SRE runbook library and claw-ops auto-execution engine. |
|
Package runner implements `nself runner provision` and `nself runner verify` (G-012): building and auditing self-hosted GitHub Actions CI runner hosts.
|
Package runner implements `nself runner provision` and `nself runner verify` (G-012): building and auditing self-hosted GitHub Actions CI runner hosts. |
|
Package runtime detects the local container runtime (Docker, OrbStack, Podman) and reports its name, binary path, version, and enterprise-mode hint.
|
Package runtime detects the local container runtime (Docker, OrbStack, Podman) and reports its name, binary path, version, and enterprise-mode hint. |
|
Package scaffold provides CS_N custom service scaffolding for nself projects.
|
Package scaffold provides CS_N custom service scaffolding for nself projects. |
|
Package search provides MeiliSearch integration helpers for the nSelf CLI.
|
Package search provides MeiliSearch integration helpers for the nSelf CLI. |
|
Package secrets — rotation scheduling, dual-key windows, and expiry alerts.
|
Package secrets — rotation scheduling, dual-key windows, and expiry alerts. |
|
Package seed implements the DB seeding fixtures system for nSelf projects.
|
Package seed implements the DB seeding fixtures system for nSelf projects. |
|
Package sentryapi is the typed REST client for the ɳSentry cloud API.
|
Package sentryapi is the typed REST client for the ɳSentry cloud API. |
|
Package server implements `nself server` (G-011): provisioning, listing, resizing, and destroying cloud servers, backed by the Hetzner Cloud API.
|
Package server implements `nself server` (G-011): provisioning, listing, resizing, and destroying cloud servers, backed by the Hetzner Cloud API. |
|
Package service provides lifecycle management for individual nSelf optional services (start, stop, restart, ps, update, scale).
|
Package service provides lifecycle management for individual nSelf optional services (start, stop, restart, ps, update, scale). |
|
Package setup implements the nself init wizard: project scaffolding, secret generation, .env file creation, and .nself/ directory setup.
|
Package setup implements the nself init wizard: project scaffolding, secret generation, .env file creation, and .nself/ directory setup. |
|
Package sqlallowlist enforces a DDL allowlist for SQL statements submitted through the nself_run_migration MCP tool.
|
Package sqlallowlist enforces a DDL allowlist for SQL statements submitted through the nself_run_migration MCP tool. |
|
Package telemetry — opt-in anonymous CLI telemetry client (S65.T01 / Q07).
|
Package telemetry — opt-in anonymous CLI telemetry client (S65.T01 / Q07). |
|
templates
|
|
|
clone
Package clone provides embedded app-clone templates for nself init --template.
|
Package clone provides embedded app-clone templates for nself init --template. |
|
Package tenant manages multi-tenant lifecycle operations for a self-hosted nSelf deployment.
|
Package tenant manages multi-tenant lifecycle operations for a self-hosted nSelf deployment. |
|
Package upgrade implements release channel selection and version resolution for the `nself upgrade` command.
|
Package upgrade implements release channel selection and version resolution for the `nself upgrade` command. |
|
Package ux provides user-experience primitives for structured CLI error display.
|
Package ux provides user-experience primitives for structured CLI error display. |
|
Package webhook provides HMAC-SHA256 signing and dispatch for nSelf webhook deliveries.
|
Package webhook provides HMAC-SHA256 signing and dispatch for nSelf webhook deliveries. |
Click to show internal directories.
Click to hide internal directories.