-
-
Notifications
You must be signed in to change notification settings - Fork 2
system requirements
This page lists the minimum requirements to install and run the ɳSelf CLI correctly across all supported platforms.
| Platform | Minimum Version | Architectures | Notes |
|---|---|---|---|
| macOS | 11 (Big Sur) | arm64, x86_64 | Apple Silicon (M1/M2/M3) natively supported , see macos-apple-silicon.md |
| Ubuntu | 20.04 long-term support | x86_64, arm64 | 22.04 long-term support and 24.04 long-term support also fully supported |
| Debian | 11 (Bullseye) | x86_64, arm64 | Bookworm (12) also supported |
| Fedora | 36 | x86_64, arm64 | Tested on current stable releases |
| Arch Linux | Rolling | x86_64, arm64 | Latest rolling release; no minimum pinned |
| Windows | 10 22H2 / 11 | x86_64 | WSL2 required , see windows-wsl2.md |
Windows note: Native Windows execution is not supported. All CLI commands must run inside a WSL2 environment. Docker Desktop for Windows with WSL2 backend satisfies the Docker requirement automatically.
| Dependency | Minimum Version | Notes |
|---|---|---|
| Docker Engine | 24.x | Linux native install |
| Docker Desktop | 4.x | macOS and Windows (WSL2 backend) |
| Docker Compose | v2.x | Bundled with Docker Desktop; install the standalone docker compose plugin on Linux headless installs |
The CLI uses docker compose (v2 plugin syntax). The legacy docker-compose (v1 standalone binary) is not supported.
| Resource | Minimum | Recommended |
|---|---|---|
| Disk | 5 GB free | 10 GB free (for a typical dev stack with images + data) |
| RAM | 4 GB | 8 GB (multi-service stack with monitoring) |
| CPU | 2 cores | 4+ cores (production or concurrent service loads) |
Docker image pulls and Postgres data volumes are the primary disk consumers. The 5 GB minimum covers a single-product install with no monitoring bundle. Enable the monitoring bundle only when the 10 GB threshold is met.
| Destination | Protocol | Purpose |
|---|---|---|
ghcr.io |
HTTPS (443) | GitHub Container Registry , CLI and service images |
docker.io |
HTTPS (443) | Docker Hub , base images |
plugins.nself.org |
HTTPS (443) | Plugin registry API |
ping.nself.org |
HTTPS (443) | License validation and telemetry |
All outbound traffic is HTTPS only. No inbound firewall rules are required for local development.
| Port | Protocol | Purpose |
|---|---|---|
| 80 | TCP | HTTP → Nginx (redirects to HTTPS) |
| 443 | TCP | HTTPS → Nginx reverse proxy |
Local dev stacks bind to 127.0.0.1 and require no inbound firewall exceptions.
These tools are not required to run the CLI but are useful for advanced workflows.
| Tool | Purpose |
|---|---|
psql (PostgreSQL client) |
Direct database access for debugging, migrations, and ad-hoc queries |
pgbouncer |
Connection pooling for high-concurrency production deployments |
jq |
JSON output parsing for scripting and automation |
curl |
Manual health-check calls to API endpoints |
- Apple Silicon (M1/M2/M3): macos-apple-silicon.md, Rosetta considerations, native arm64 images, known issues
- Windows / WSL2 setup: windows-wsl2.md, WSL2 installation, Docker Desktop WSL2 backend, file-system path notes
- Installation: Installation.md, step-by-step install for each platform
- Quick Start: Quick-Start.md, first project after install
ɳSelf CLI v1.0.9. MIT licensed. Docs CC BY 4.0.
GitHub · Issues · Discussions · nself.org · nself.org/docs
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-nTV, Media Player
- 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
- 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
- plugin-nself-ai-gateway
- plugin-nself-ai-mcp
- plugin-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
- 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
All commands (52)
- A: cmd-access · cmd-account · cmd-admin
- B: cmd-backup · cmd-build · cmd-bundle
- C: cmd-ci · cmd-clean · cmd-completion · cmd-config
- D: cmd-db · cmd-deploy · cmd-dev · cmd-doctor
- E: cmd-env · cmd-exec
- F: cmd-functions
- G: cmd-generate
- H: cmd-health · cmd-help-topics
- I: cmd-init · cmd-install
- L: cmd-license · cmd-login · cmd-logout · cmd-logs
- M: cmd-man · cmd-mcp · cmd-migrate
- O: cmd-oauth · cmd-ops
- P: cmd-plugin · cmd-promote
- R: cmd-remove · cmd-reset · cmd-restart · cmd-runner
- S: cmd-secrets · cmd-security · cmd-self-heal · cmd-server · cmd-service · cmd-start · cmd-status · cmd-stop
- T: cmd-telemetry · cmd-template · cmd-trust
- U: cmd-update · cmd-urls
- V: cmd-verify-sbom · cmd-version