The core nSelf CLI commands cover the full lifecycle of a project: initialize, build, start, stop, restart, and reset. These commands work the same on macOS, Linux, and Windows. Source of truth: SPORT F02-COMMAND-INVENTORY.md.
Initialize a new nSelf project with an interactive configuration wizard.
nself init # Interactive wizard
nself init --profile=tiny # Small VPS profile (low memory)Compose your infrastructure from .env. Generates docker-compose.yml, nginx configs, and SSL certificates. Run after every .env change.
nself build # Generate all config files
nself build --dry-run # Preview without writing filesBoot your nSelf stack — starts all Docker services with health checks and automatic database initialization. Alias: nself up.
nself start # Start all services
nself start --build # Rebuild containers first
nself start --force-recreate # Force recreate containersGracefully shut down all services or specific named services. Alias: nself down.
nself stop # Stop all services
nself stop postgres redis # Stop specific servicesSmart restart with config change detection — only restarts services whose config changed.
nself restart # Restart all services
nself restart hasura # Restart specific serviceStop containers, remove all data volumes, and clean generated files. Destructive — all database data is lost. Use for a clean slate.
nself reset # Full reset (prompts for confirmation)Remove generated artifacts — docker-compose.yml, nginx configs, and build cache. Does not touch data volumes.
nself clean # Remove generated filesExecute a command inside a running service container.
nself exec postgres psql -U postgres # Open psql shell
nself exec hasura bash # Open bash in hasura containerOpen the nSelf Admin dashboard in your browser. Admin runs atlocalhost:3021 — it is a local tool, not a hosted service.
nself admin # Open admin (starts if not running)
nself admin connect <host> # Connect to remote nSelf instance
nself admin projects list # List remote projects
nself admin projects add # Add a project
nself admin projects remove <id> # Remove a projectShow health status of all services. --deep runs extended service health and plugin reachability probes.
nself status # All services status
nself status postgres # Single service
nself status --deep # Extended probes + plugin reachabilityView and filter service logs.
nself logs # All service logs
nself logs hasura # Single service logs
nself logs hasura --tail 100 # Last 100 linesHealth check management with continuous monitoring.
nself health check # Run all health checks
nself health service <name> # Check specific service
nself health endpoint <url> # Check a custom endpoint
nself health watch # Continuous monitoring
nself health history # Health check history
nself health config # Health check configurationDisplay all service URLs with route conflict detection.
nself urls # Show all service URLsRun comprehensive system diagnostics (~14 internal checks). --deep runs the full hardening suite without a license (Security-Always-Free doctrine — also runs automatically on install, update, deploy, and daily cron).
nself doctor # System diagnostics
nself doctor --deep # Full hardening suite (free, no license needed)Show version and system information.
nself versionUpdate the nSelf CLI binary and admin UI. images updates Docker images.
nself update # Update CLI
nself update images # Update Docker service images