Repository navigation
Compat V15
NSELF_V15 is the one switch for behaviour changes that break an existing user-visible contract (JSON shapes, exit codes, command moves, tool names). Patch releases keep shipping from main, so a breaking change lands dormant: the old behaviour stays the default until v1.5.0 flips it (ADR 0021).
| Value | Mode | Meaning |
|---|---|---|
1, true, TRUE, True (any case of true) |
v1.5 | New behaviour on. 1 is the ADR 0021 spelling. |
unset, empty, 0, false, yes, anything else |
v1.4 | Old behaviour. |
Default: off in 1.4.x. On from v1.5.0, where the CLI stops reading the variable. New additive surfaces (a new flag, a new subcommand) are not gated.
The Go side is internal/compat: compat.V15() reads the environment on every call (never cached), and compat.Mode() returns v1.4 or v1.5.
NSELF_V15=1 nself status --json # one command
export NSELF_V15=1 # a whole shell, agent session or CI jobAgents and CI contract jobs run in both modes.
A gated branch carries this marker on the line above (or the same line as) the compat.V15() call:
// compat.V15(P7-REG-09): old behaviour -> new behaviour
if compat.V15() {scripts/ci/compat-markers.sh lists every gated branch as <file>:<line> <ticket-id>, fails when a call has no marker, and regenerates the table below:
bash scripts/ci/compat-markers.sh # list markers
bash scripts/ci/compat-markers.sh --write-wiki # regenerate the table (after rebase)
bash scripts/ci/compat-markers.sh --check # exit 1 when the table is staleTest both modes with compattest.Both from internal/compat/compattest; it runs the body as subtests v1.4 and v1.5. Use compattest.Set(t, on) for one mode. Tests never branch on a bare compat.V15().
The table is generated. Never hand-edit it; run compat-markers.sh --write-wiki.
| Ticket | v1.4 behaviour (old) | v1.5 behaviour (new) | File |
|---|---|---|---|
| P7-ADOPT-01 | writable absolute bind allowed | E502 | internal/compose/custom_service_v2.go |
| P7-CANON-01 | same-owner breakout stays core in v1.4 | mounts from its plugin in v1.5 | cmd/commands/plugin_mount.go |
| P7-CANON-02 | registry view with moved entries at their v1.4 paths | view at canonical paths plus deprecated-shim entries | internal/canon/canon.go |
| P7-CANON-05 | help | next step + help | cmd/commands/root.go |
| P7-CANON-08 | no hint | Next: nself --help | cmd/commands/install_builtin.go |
| P7-CANON-19 | account group | plugin commands group | cmd/commands/builtin_families.go |
| P7-CANON-21 | the argv names commands at their v1.4 paths | argv rewritten between old and canonical spellings, tree relocated | cmd/commands/tree_prepare.go |
| P7-DEPL-13 | accept-new | strict for secret shipping and prod targets. | internal/deploy/ssh.go |
| P7-DEPL-13 | accept-new | strict host key checking for access writes. | internal/access/transport_ssh.go |
| P7-DEPL-13 | quiet read-only first contact | print the observed fingerprint once. | internal/controlplane/hostkeys.go |
| P7-DEPL-13 | silent legacy host path | warn once until removal at v1.6.0. | internal/controlplane/tiers.go |
| P7-LIVE-03 | a lock held by another command does not stop a build (it takes the O_EXCL build.lock) | a lock held by another command refuses the build | internal/build/build_lock.go |
| P7-LIVE-03 | a prod-class or hand-edited change proceeds with a notice | refused with E403 without --yes or --force | internal/reconcile/apply.go |
| P7-LIVE-13 | a held lock is polled for 30 s, then a warning and the command runs unlocked | a held lock fails at once with E460 | internal/oplock/guard.go |
| P7-LIVE-17 | IMAGE_PINNING defaults to legacy | lock | internal/compose/images_lock.go |
| P7-PLUG-01 | v1 plugin.json read silently | one deprecation line per process on stderr | internal/plugin/manifestv2/warn.go |
| P7-PLUG-11 | tier pro | license licensed | cmd/commands/plugin_marketplace_cmds.go |
| P7-PLUG-11 | tier pro | license licensed | cmd/commands/plugin_query.go |
| P7-PLUG-11 | tier pro | license licensed | cmd/commands/plugin_search.go |
| P7-PLUG-63 | bundle reply trusted for any key and bundle | only a signed reply naming this key, this bundle and a live window | internal/license/cache_entry.go |
| P7-PLUG-63 | cache age from the unsigned fetched_at | the older of fetched_at and the signed jwt iat | internal/license/cache_entry.go |
| P7-PLUG-63 | cache trusted whatever the clock says | refused when the clock is behind the signed iat or the highest time seen | internal/license/cache.go |
| P7-PLUG-63 | cache trusted without a signature check | only a cache whose server-signed body verifies | internal/license/cache_entry.go |
| P7-PLUG-63 | fail-open past the licence expiry | refused once the signed expiry plus the post-expiry grace has passed | internal/license/cache.go |
| P7-PLUG-63 | no trusted-time mark | mark raised to now after each trusted decision | internal/license/cache.go |
| P7-PLUG-63 | no trusted-time mark | mark reset to the signed iat of each verified reply | internal/license/cache.go |
| P7-PLUG-63 | plugins field ping never sends (always empty) | plugins_allowed | internal/license/cache_entry.go |
| P7-PLUG-63 | post-expiry grace ignores cache age | post-expiry write access also needs a cache younger than the 7-day offline ceiling | internal/license/cache.go |
| P7-PLUG-63 | signature over a locally built payload | server signature over the raw body | internal/license/cache_entry.go |
| P7-PLUG-63 | signed reply trusted for any licence | only a reply whose signed jwt names this key and is in window | internal/license/cache_entry.go |
| P7-PLUG-63 | unsigned bundle response accepted | unsigned bundle response refused | internal/license/checker.go |
| P7-PROD-08 | age-key.txt only | shared identity search, E223 when none | internal/backup/restore.go |
| P7-PROD-08 | age-key.txt only | shared identity search, E223 when none | internal/backup/stream_restore_remote.go |
| P7-PROD-08 | only FATAL or "could not" fails | any unlisted pg_restore error: line fails | internal/backup/drill_support.go |
| P7-PROD-08 | refuse | auto identity | internal/backup/autokey.go |
| P7-REG-02 | bare pre-contract JSON | v1 envelope (NSELF_JSON_LEGACY=1 or true keeps bare JSON for one minor) | internal/output/legacy.go |
| P7-REG-05 | --json accepted and ignored on a command whose own json flag predates P7-REG | refused with E402 | cmd/commands/invocation.go |
| P7-REG-05 | flag and argument errors keep cobra's text | wrapped as E401 | cmd/commands/invocation.go |
| P7-REG-05 | registry reports v1.4 exit codes and hides v1.5-only envelopes | v1.5 exit codes and envelopes | cmd/commands/registry.go |
| P7-REG-06 | a panic crashes the process with the raw Go runtime trace and exit 2 | the panic is reported as an "internal error" (error envelope in JSON mode, stack trace on stderr only), still exit 2 | cmd/nself/safe.go |
| P7-REG-06 | exit status 1 and a plain "Error: msg" line for every failure | exit classes 2/3/4, "Error: [Exxx]" block on stderr and a JSON error envelope on stdout | cmd/nself/report.go |
| P7-REG-09 | --json ignored | envelope | cmd/commands/config_list_validate.go |
| P7-REG-09 | --json ignored | envelope | cmd/commands/config_show_get.go |
| P7-REG-09 | bare pre-contract JSON | v1 envelope whose data adds state
|
cmd/commands/config_json_types.go |
| P7-REG-09 | doctor --json exits 0 | 10 (failed) or 12 (warnings only) | cmd/commands/doctor_health_report.go |
| P7-REG-09 | doctor --json prints the passed-check lines on stdout before the JSON | on stderr, so stdout is one document | cmd/commands/doctor_health_report.go |
| P7-REG-09 | doctor exits 1 (failed) or 2 (warnings only) | 10 (failed) or 12 (warnings only) | cmd/commands/doctor_health_report.go |
| P7-REG-09 | human status exits 2 | 10 (unhealthy) or 11 (starting) | cmd/commands/status.go |
| P7-REG-09 | status exits 2 (unhealthy) or 1 (starting), 0 with --json | 10 (unhealthy) or 11 (starting) in both modes | cmd/commands/status_print.go |
| P7-SURF-07 | nself.yaml type errors and unknown keys warn | fail (E435/E436) | internal/build/manifest_validate.go |
Getting Started
Commands
- Commands, Overview
- Lifecycle: cmd-init · cmd-build · cmd-start · cmd-stop · cmd-restart · cmd-dev
- Monitoring: cmd-status · cmd-logs · cmd-health · cmd-urls · cmd-doctor · cmd-monitor · cmd-alerts · cmd-sentry · cmd-watchdog
- Data: cmd-db · cmd-backup · cmd-dr · cmd-queue · cmd-webhooks
- Config: cmd-config · cmd-service · cmd-env · cmd-promote
- Networking: cmd-ssl · cmd-trust · cmd-dns-setup
- Security: cmd-access · cmd-security · cmd-secrets
- Tenancy: cmd-tenant · cmd-billing
- Plugins: cmd-plugin · cmd-license · cmd-dogfood (extracted, CLI-R11) · cmd-k8s (extracted, CLI-R11) · cmd-encryption (extracted, CLI-R11) · cmd-waf (extracted, CLI-R11) · cmd-federation (extracted, CLI-R11) · cmd-mail (extracted, CLI-R11) · cmd-dlq (extracted, CLI-R11)
- AI: cmd-ai · cmd-claw · cmd-model
- Templates: cmd-template
- Utilities: cmd-exec · cmd-clean · cmd-reset · cmd-update · cmd-upgrade · cmd-version · cmd-admin · cmd-migrate · cmd-migrate-firebase · cmd-migrate-supabase · cmd-completion
Features
- Features, Overview
- Feature-Auth
- Feature-Storage
- Feature-Search
- Feature-Functions
- Feature-Email
- Feature-Monitoring
- Feature-Plugins
- Feature-nClaw, AI Assistant
- Feature-nChat, Messaging
- Feature-nFamily, Family Social
- Feature-nCloud, Managed Hosting
- Feature-Memory-Rooms, Knowledge Organization
- Feature-Agent-Dashboard, Agent Metrics
- Feature-Image-Generation, AI Image Generation
Configuration
- Configuration, Overview
- Config-Env-Vars
- Config-Postgres
- Config-Hasura
- Config-Auth
- Config-Nginx
- Shared-Proxy
- Config-Optional-Services
- Config-Custom-Services
- Config-System
Plugins (87 + 10 monitoring)
- Plugin-Overview
- Plugin-Catalog
- Plugin-Install
- Plugin-Licensing
- Plugin-Architecture
- Plugin-Dev-Guide
- Plugin-Migrations-Contract
Free (25)
- plugin-backup
- plugin-content-acquisition
- plugin-content-progress
- plugin-cron
- plugin-donorbox
- plugin-feature-flags
- plugin-github
- plugin-github-runner
- plugin-invitations
- plugin-jobs
- plugin-link-preview
- plugin-mdns
- plugin-mlflow
- plugin-monitoring
- plugin-notifications
- plugin-notify
- plugin-paypal
- plugin-search
- plugin-shopify
- plugin-stripe
- plugin-subtitle-manager
- plugin-tokens
- plugin-torrent-manager
- plugin-vpn
- plugin-webhooks
Pro (62)
- plugin-access-controls
- plugin-activity-feed
- plugin-admin-api
- plugin-analytics
- plugin-auth
- plugin-bots
- plugin-browser
- plugin-calendar
- plugin-cdn
- plugin-chat
- plugin-claw
- plugin-claw-budget
- plugin-claw-news
- plugin-claw-web
- plugin-cloudflare
- plugin-cms
- plugin-compliance
- plugin-ddns
- plugin-devices
- plugin-documents
- plugin-entitlements
- plugin-file-processing
- plugin-game-metadata
- plugin-geocoding
- plugin-geolocation
- plugin-google
- plugin-home
- plugin-idme
- plugin-knowledge-base
- plugin-linkedin
- plugin-livekit
- plugin-media-processing
- plugin-meetings
- plugin-moderation
- plugin-mux
- plugin-object-storage
- plugin-observability
- plugin-photos
- plugin-podcast
- plugin-post
- plugin-realtime
- plugin-retro-gaming
- plugin-rom-discovery
- plugin-social
- plugin-sports
- plugin-support
- plugin-tmdb
- plugin-voice
- plugin-web3
- plugin-workflows
Planned (26)
plugin-auditplugin-blogplugin-checkoutplugin-commerceplugin-drmplugin-exportplugin-flowplugin-importplugin-ldapplugin-mailgunplugin-mediaplugin-oauth-providersplugin-pagesplugin-postmarkplugin-rate-limitplugin-reportsplugin-samlplugin-schedulerplugin-sendgridplugin-ssoplugin-subscriptionplugin-thumbplugin-transcoderplugin-twilioplugin-wafplugin-watermark
Guides
- Guide-Production-Deployment
- Guide-SSL-Setup
- Guide-Multi-Tenancy
- Guide-Security-Hardening
- Guide-Monitoring-Setup
- Guide-Backup-Restore
- Guide-Custom-Services
- Guide-Migration-from-v1
Architecture
- Architecture
- Architecture-Guardrails
- Service-Graph
- Compose-Generation
- Nginx-Generation
- Plugin-Architecture
Reference
Machine interface
-
JSON-Output,
--jsonenvelope -
Command-Registry,
nself help --json - Exit-Codes
- error-codes, Error Codes
-
Compat-V15,
NSELF_V15gate
Licensing
Security
Brand
Operations
- operations/release-cascade, Release Cascade
- operations/self-healing, Self-Healing Schema
- operations/redis-tuning, Redis Pool Tuning
- operations/meilisearch-warmup, MeiliSearch Warm-Up
- operations/jwt-rotation, JWT Key Rotation
- operations/windows-wsl2-setup, Windows / WSL2 Setup
- operations/gemini-oauth-reauth, Gemini OAuth Reauth
Contributing
Admin
- USER-ACTION-QUEUE, Pending Admin Actions
All commands (21)
- A: cmd-add · cmd-admin
- B: cmd-backup · cmd-build
- C: cmd-clean · cmd-config
- D: cmd-db · cmd-deploy · cmd-doctor
- E: cmd-exec
- I: cmd-init
- L: cmd-license · cmd-logs
- M: cmd-mcp
- R: cmd-remove · cmd-reset · cmd-restart
- S: cmd-start · cmd-status · cmd-stop
- U: cmd-update