-
-
Notifications
You must be signed in to change notification settings - Fork 2
COMMANDS
github-actions[bot] edited this page Jul 1, 2026
·
17 revisions
ɳSelf CLI provides 58 documented commands with wiki pages. Each command links to a dedicated page with full usage, flags, and examples.
| Command | Description |
|---|---|
| cmd-init | Initialize a new ɳSelf project , generates .env configuration via interactive wizard |
| cmd-build | Compose infrastructure from .env , generates docker-compose.yml, Nginx config, and SSL certificates |
| cmd-start | Boot the ɳSelf stack with health checks and automatic database initialization (alias: up) |
| cmd-stop | Gracefully shut down all services or specific named services (alias: down) |
| cmd-restart | Smart restart with config change detection , only restarts affected services |
| cmd-dev | Start development environment with optional plugin hot-reload |
| cmd-reset | Stop containers and remove generated files (preserves .env and data) |
| cmd-clean | Remove Docker resources associated with the current project |
| Command | Description |
|---|---|
| cmd-status | Show health status of all services with exit code signaling |
| cmd-logs | View and filter service logs with color, search, and tail support |
| cmd-health | Health check management , check, watch, history, single service or endpoint |
| cmd-doctor | Run full system diagnostics: infrastructure, Docker, config, network |
| cmd-urls | Display all service URLs grouped by type with route conflict detection |
| cmd-monitor | Monitoring stack management (Grafana dashboard upgrades) |
| cmd-alerts | Manage Prometheus alert rules and silences |
| cmd-sentry | Operate ɳSentry monitoring: monitors, incidents, status pages, alert channels (SaaS or self-hosted) |
| cmd-watchdog | Self-healing container watchdog with circuit breaker |
| cmd-dogfood | Production dogfood audit and reporting |
| Command | Description |
|---|---|
| cmd-db | Database operations , migrate, seed, backup, restore, shell, reset, Hasura metadata |
| cmd-backup | Backup operations: create, list, restore, verify, prune, config, status, init-key |
| cmd-dr | Disaster recovery: drill, promote-standby, reconfigure-dns, rollback, fence |
| cmd-queue | Manage async job queues (pg-boss) |
| cmd-webhooks | Manage webhook processing and outbox |
| Command | Description |
|---|---|
| cmd-config | Manage project configuration , show, get, set, list, validate, export, import |
| cmd-env | Multi-environment management: switch, list, diff, copy |
| cmd-federation | Manage GraphQL Federation for multi-service nSelf deployments |
| cmd-infra | Provision nSelf infrastructure on cloud providers via Terraform |
| cmd-promote | Promote one environment to another (e.g. staging to prod) |
| cmd-region | Manage multi-region Postgres replicas for a self-hosted nSelf deployment |
| cmd-service | Enable, disable, and list optional services (Redis, MinIO, email, search, monitoring) |
| Command | Description |
|---|---|
| cmd-ssl | Manage SSL certificates , status and force renewal |
| cmd-trust | Set up local dev trust (DNS, SSL, port forwarding) |
| cmd-dns-setup | Add project domains to /etc/hosts (run with sudo) |
| Command | Description |
|---|---|
| cmd-encryption | Manage BYOK per-tenant encryption for nSelf Cloud (Enterprise tier only) |
| cmd-secrets | Manage encrypted project secrets (age encryption) |
| cmd-security | Security audit, setup, and status for hardening your deployment |
| cmd-waf | Manage the Web Application Firewall (Coraza + OWASP CRS) |
| Command | Description |
|---|---|
| cmd-tenant | Tenant management: create, upgrade, suspend, destroy, audit |
| cmd-billing | Billing operations: usage, invoice-preview, report, retry-event |
| Command | Description |
|---|---|
| cmd-plugin | Manage ɳSelf plugins , install, remove, update, list, start, stop, status |
| cmd-license | Manage Pro membership license key , set, show, validate, clear, upgrade |
| Command | Description |
|---|---|
| cmd-release | Orchestrate a full versioned release across all nSelf distribution surfaces |
| cmd-release-check | Run pre-flight validation before a release |
| cmd-release-rollback | Roll back distribution surfaces to a prior release version |
| cmd-release-status | View the live deployment status of all release distribution surfaces |
| Command | Description |
|---|---|
| cmd-ai | Manage the ɳSelf AI plugin and local LLM stack |
| cmd-ai-studio | Google AI Studio integration for local nSelf instances via a secure Cloudflare Tunnel |
| cmd-claw | Manage ɳClaw AI assistant |
| cmd-claw-session | Manage Claude Code PTY sessions via nself-ai-cc (port 3760) — start, list, attach, stop |
| cmd-gateway | Manage the nSelf AI gateway (port 3761) — status, keys, quota, routes |
| cmd-mcp | Start the nSelf MCP server and expose infrastructure tools to Claude Code and other MCP clients |
| cmd-ollama | Deprecated alias — use nself model --provider ollama instead |
| Command | Description |
|---|---|
| cmd-admin | Open the ɳSelf Admin dashboard in browser at localhost:3021
|
| cmd-completion | Generate shell completion scripts for bash, zsh, fish, or PowerShell |
| cmd-costs | Show an itemized breakdown of estimated monthly operational costs for your nSelf install |
| cmd-exec | Execute a command inside a running service container |
| cmd-feature | Manage CLI-built-in feature flags for build-time and install-time capability gates |
| cmd-help-topics | Browse built-in help topics for common nSelf tasks |
| cmd-k8s | Deploy and manage nSelf on any Kubernetes cluster using the official Helm chart |
| cmd-man | Generate man pages for all nself commands |
| cmd-migrate | Detect and migrate v1 (Bash CLI) artifacts to v2 |
| cmd-migrate-from-v099 | Migrate v0.9.9 home-level state (license key, update channel, SSH keys) to the v1.x layout |
| cmd-self-heal | Run targeted repair routines for nSelf components without a full stack rebuild |
| cmd-uninstall | Remove nSelf-generated files and containers from the current project directory |
| cmd-update | Update the ɳSelf CLI binary and admin Docker image |
| cmd-upgrade | Upgrade the ɳSelf CLI (detects install method) |
| cmd-version | Show version and system information |
ɳSelf CLI v1.0.9. MIT licensed. Docs CC BY 4.0.
GitHub · Issues · Discussions · nself.org · docs.nself.org
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 · cmd-dogfood
- 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-security · cmd-secrets · cmd-waf
- Tenancy: cmd-tenant · cmd-billing
- Plugins: cmd-plugin · cmd-license
- 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-ɳClaw, AI Assistant
- Feature-ɳChat, Messaging
- Feature-ɳTV, Media Player
- Feature-ɳFamily, Family Social
- Feature-ɳCloud, 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
- Config-Optional-Services
- Config-Custom-Services
- Config-System
Plugins (87 + 10 monitoring)
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
- nself-ai-gateway
- nself-ai-cc
- nself-ai-mcp
- plugin-analytics
- plugin-auth
- plugin-backup-pro
- 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-cron-pro
- plugin-ddns
- plugin-devices
- plugin-documents
- plugin-donorbox-pro
- plugin-entitlements
- plugin-epg
- 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-notify-pro
- plugin-object-storage
- plugin-observability
- plugin-paypal-pro
- plugin-photos
- plugin-podcast
- plugin-post
- plugin-realtime
- plugin-recording
- plugin-retro-gaming
- plugin-rom-discovery
- plugin-shopify-pro
- plugin-social
- plugin-sports
- plugin-stream-gateway
- plugin-streaming
- plugin-stripe-pro
- 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
Reference
- API-Reference
- reference-error-codes, Error Codes
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