Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
aistudio
Package aistudio implements the `nself ai-studio` command subtree.
|
Package aistudio implements the `nself ai-studio` command subtree. |
|
commands
P88 Sprint 05: `nself ai chat` — quick chat for verification.
|
P88 Sprint 05: `nself ai chat` — quick chat for verification. |
|
nself
command
|
|
|
nself-backup-archive
command
nself-backup-archive is a helper binary used as PostgreSQL's archive_command.
|
nself-backup-archive is a helper binary used as PostgreSQL's archive_command. |
|
internal
|
|
|
admin
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. |
|
aiprofile
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. |
|
alerts
Package alerts manages Prometheus alert rules and Alertmanager routing for nSelf.
|
Package alerts manages Prometheus alert rules and Alertmanager routing for nSelf. |
|
apidocs
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. |
|
auth
Package auth — HTTP client for nSelf auth server operations.
|
Package auth — HTTP client for nSelf auth server operations. |
|
backup
Package backup provides path validation helpers for backup operations.
|
Package backup provides path validation helpers for backup operations. |
|
backup/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. |
|
backup/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. |
|
build
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. |
|
bundle
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). |
|
compose
Package compose: service toggle helper.
|
Package compose: service toggle helper. |
|
compose/monitoring
Package monitoring — alert rule and Alertmanager config generators.
|
Package monitoring — alert rule and Alertmanager config generators. |
|
config
Package config — user-level telemetry preference management.
|
Package config — user-level telemetry preference management. |
|
controlplane
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. |
|
controlplane/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. |
|
cost
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. |
|
database
Package database — drill.go: high-level DR drill orchestration.
|
Package database — drill.go: high-level DR drill orchestration. |
|
deploy
Package deploy provides deployment management for the nSelf CLI.
|
Package deploy provides deployment management for the nSelf CLI. |
|
deploy/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). |
|
deprecation
Package deprecation — G4: sunset date computation for per-plugin API entries.
|
Package deprecation — G4: sunset date computation for per-plugin API entries. |
|
dlq
Package dlq provides helpers for nself dlq replay.
|
Package dlq provides helpers for nself dlq replay. |
|
doctor
S77-T08: doctor --deep check for orphaned Hasura remote schemas.
|
S77-T08: doctor --deep check for orphaned Hasura remote schemas. |
|
dogfood
Package dogfood implements the nSelf dogfood audit system for production health verification.
|
Package dogfood implements the nSelf dogfood audit system for production health verification. |
|
domain
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. |
|
dr
Package dr provides disaster recovery operations: drills, standby promotion, rollback, and split-brain fencing.
|
Package dr provides disaster recovery operations: drills, standby promotion, rollback, and split-brain fencing. |
|
embedded
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. |
|
env
Package env implements multi-environment management for nSelf projects.
|
Package env implements multi-environment management for nSelf projects. |
|
errors
Package errors provides the canonical error catalog for the nSelf CLI.
|
Package errors provides the canonical error catalog for the nSelf CLI. |
|
errs
Package errs defines sentinel errors for the nself CLI.
|
Package errs defines sentinel errors for the nself CLI. |
|
featureflags
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. |
|
federation
Package federation implements GraphQL Federation support for multi-service nSelf deployments.
|
Package federation implements GraphQL Federation support for multi-service nSelf deployments. |
|
flags
Package flags provides a thin REST client over the nself feature-flags plugin (port 3305, nginx-proxied).
|
Package flags provides a thin REST client over the nself feature-flags plugin (port 3305, nginx-proxied). |
|
gdpr
Package gdpr provides GDPR data portability (Art.
|
Package gdpr provides GDPR data portability (Art. |
|
generate
Package generate provides the schema codegen engine for nself generate.
|
Package generate provides the schema codegen engine for nself generate. |
|
health
Package health provides health checking utilities for nSelf services.
|
Package health provides health checking utilities for nSelf services. |
|
httptimeout
Package httptimeout provides timeout-bounded *http.Client values per scope.
|
Package httptimeout provides timeout-bounded *http.Client values per scope. |
|
infra
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). |
|
installer
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). |
|
installmeta
Package installmeta persists install-time metadata to ~/.nself/install-meta.json.
|
Package installmeta persists install-time metadata to ~/.nself/install-meta.json. |
|
k8s
Package k8s provides a thin wrapper around the Helm CLI for managing nSelf Helm chart deployments (B50).
|
Package k8s provides a thin wrapper around the Helm CLI for managing nSelf Helm chart deployments (B50). |
|
license
Package license — banner.go provides warning banner text for grace period states.
|
Package license — banner.go provides warning banner text for grace period states. |
|
mail
Package mail provides an HTTP client for the ping_api /mail/* endpoints.
|
Package mail provides an HTTP client for the ping_api /mail/* endpoints. |
|
maintenance
Package maintenance — daily Hasura metadata backup cron registration.
|
Package maintenance — daily Hasura metadata backup cron registration. |
|
metrics
Package metrics emits Prometheus-compatible metrics written to a textfile collector directory for node_exporter to scrape.
|
Package metrics emits Prometheus-compatible metrics written to a textfile collector directory for node_exporter to scrape. |
|
migrate
Package migrate provides migration helpers for legacy nSelf project layouts.
|
Package migrate provides migration helpers for legacy nSelf project layouts. |
|
migrate/firebase
Package firebase implements the Firebase → nSelf migration scaffold.
|
Package firebase implements the Firebase → nSelf migration scaffold. |
|
migrate/supabase
Package supabase implements the Supabase → nSelf migration pipeline.
|
Package supabase implements the Supabase → nSelf migration pipeline. |
|
migrationai
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. |
|
model
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>/). |
|
monitoring
Package monitoring handles Grafana dashboard provisioning for nself monitoring plugin.
|
Package monitoring handles Grafana dashboard provisioning for nself monitoring plugin. |
|
nginx
Package nginx provides Nginx configuration generation and management for the nSelf CLI.
|
Package nginx provides Nginx configuration generation and management for the nSelf CLI. |
|
oauth
Package oauth provides manual OAuth token refresh helpers.
|
Package oauth provides manual OAuth token refresh helpers. |
|
observability
Package observability provides shared Prometheus metrics and OpenTelemetry tracing helpers for all nSelf Go services.
|
Package observability provides shared Prometheus metrics and OpenTelemetry tracing helpers for all nSelf Go services. |
|
onboarding
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. |
|
plugin
Package plugin — lifecycle audit helpers.
|
Package plugin — lifecycle audit helpers. |
|
plugin/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. |
|
plugin/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. |
|
ports
Package ports provides port-holder identification utilities for the nSelf CLI.
|
Package ports provides port-holder identification utilities for the nSelf CLI. |
|
promote
Package promote implements staging-to-production promotion with diff preview and rollback.
|
Package promote implements staging-to-production promotion with diff preview and rollback. |
|
queue
Package queue provides CLI integration for the pg-boss queue/jobs plugin.
|
Package queue provides CLI integration for the pg-boss queue/jobs plugin. |
|
region
Package region implements multi-region awareness for nSelf deployments (B49).
|
Package region implements multi-region awareness for nSelf deployments (B49). |
|
runbook
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. |
|
runtime
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. |
|
scaffold
Package scaffold provides CS_N custom service scaffolding for nself projects.
|
Package scaffold provides CS_N custom service scaffolding for nself projects. |
|
search
Package search provides MeiliSearch integration helpers for the nSelf CLI.
|
Package search provides MeiliSearch integration helpers for the nSelf CLI. |
|
secrets
Package secrets — rotation scheduling, dual-key windows, and expiry alerts.
|
Package secrets — rotation scheduling, dual-key windows, and expiry alerts. |
|
seed
Package seed implements the DB seeding fixtures system for nSelf projects.
|
Package seed implements the DB seeding fixtures system for nSelf projects. |
|
service
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). |
|
setup
Package setup — .env.ai generator for P88 Zero-Config AI (Sprint 01, T-01-09).
|
Package setup — .env.ai generator for P88 Zero-Config AI (Sprint 01, T-01-09). |
|
soak
Package soak provides helpers for nself soak abort --rollback.
|
Package soak provides helpers for nself soak abort --rollback. |
|
telemetry
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. |
|
tenant
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. |
|
upgrade
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. |
|
ux
Package ux provides user-experience primitives for structured CLI error display.
|
Package ux provides user-experience primitives for structured CLI error display. |
|
watchdog
Package watchdog implements self-healing container monitoring with circuit breaker.
|
Package watchdog implements self-healing container monitoring with circuit breaker. |
|
webhook
Package webhook provides HMAC-SHA256 signing and dispatch for nSelf webhook deliveries.
|
Package webhook provides HMAC-SHA256 signing and dispatch for nSelf webhook deliveries. |
|
tools
|
|
|
endpoint-auth-checker
command
Package main — allowlist.go Known-safe auth middleware names and exempt route patterns.
|
Package main — allowlist.go Known-safe auth middleware names and exempt route patterns. |
Click to show internal directories.
Click to hide internal directories.