-
-
Notifications
You must be signed in to change notification settings - Fork 2
windows wsl2
Native Windows binary is NOT supported in v1.0.9. WSL2 + Docker Desktop is the supported path for Windows users. Native Windows binary (
windows-amd64.zip+install.ps1) is planned for v1.1.0. See the OS support matrix for details.
This guide covers installing ɳSelf CLI on Windows using WSL2 (Windows Subsystem for Linux). Tested on Windows 10 (22H2+) and Windows 11.
| Requirement | Minimum | Notes |
|---|---|---|
| Windows | 10 22H2 or Windows 11 | WSL2 requires these builds |
| WSL2 | 2.x | Run wsl --version to check |
| Docker Desktop | 4.25+ | Must enable WSL2 backend |
| Virtualization | Enabled in BIOS/UEFI | Required for Hyper-V / WSL2 |
| RAM | 8 GB+ | 4 GB minimum; WSL2 uses ~1–2 GB |
WSL2 requires CPU virtualization. Before installing, verify it is enabled:
- Open Task Manager → Performance → CPU
- Check that "Virtualization: Enabled" appears in the lower right
If disabled, reboot into BIOS/UEFI:
- Intel: enable VT-x (Intel Virtualization Technology)
- AMD: enable AMD-V or SVM Mode
The setting location varies by motherboard vendor, search your model + "enable virtualization BIOS".
Open PowerShell as Administrator and run:
wsl --installThis installs WSL2 and Ubuntu (default distribution) in one command. Restart your computer when prompted.
After restart, Ubuntu will finish setup and prompt you to create a Linux username and password.
Verify WSL2 is active:
wsl --version
# WSL version: 2.x.xIf you already have WSL1, upgrade:
wsl --set-default-version 2Configure Git inside WSL to use Unix line endings:
git config --global core.autocrlf inputThis prevents Windows CRLF line endings from corrupting shell scripts inside WSL.
- Download Docker Desktop for Windows from docs.docker.com/desktop/install/windows-install/
- During install, select Use WSL2 instead of Hyper-V (or both)
- After install:
Docker Desktop → Settings → Resources → WSL Integration → Enable for your distro (Ubuntu) - Apply and restart Docker Desktop
Verify inside WSL:
docker --version # Docker version 24+
docker compose version # Docker Compose version v2+Open the Ubuntu terminal (Start → Ubuntu) and run:
curl -sSL https://install.nself.org | bashOr manually:
VERSION=$(curl -s https://api.github.com/repos/nself-org/cli/releases/latest | grep '"tag_name"' | cut -d'"' -f4)
curl -L "https://github.com/nself-org/cli/releases/download/${VERSION}/nself-linux-amd64.tar.gz" -o nself.tar.gz
tar -xzf nself.tar.gz
sudo mv nself /usr/local/bin/nself
chmod +x /usr/local/bin/nselfnself version
# nself v1.0.9 (linux/amd64)
nself doctor
# All checks should show greenGenerate ɳSelf tab-completion for PowerShell (run ɳSelf commands from PowerShell via WSL):
nself completion powershell | Out-String | Invoke-ExpressionTo persist across sessions, add to your PowerShell profile:
nself completion powershell >> $PROFILEwsl --install fails with "feature not supported"
Your Windows version is too old or virtualization is disabled. Update Windows to 22H2+ and enable virtualization in BIOS (Step 1).
Docker commands fail inside WSL: "cannot connect to Docker daemon"
Ensure Docker Desktop is running (check the system tray) and WSL Integration is enabled for your distro in Docker Desktop settings.
nself start reports port already in use
A Windows service (e.g., PostgreSQL, Redis) may use the same port.
Stop the conflicting service or change the port in your .env file.
Run netstat -aon | findstr :<port> in PowerShell to find the process.
Slow file I/O on Windows-mounted paths
Keep your ɳSelf project inside the WSL filesystem (e.g., /home/user/projects/),
NOT on the Windows drive (/mnt/c/). Cross-filesystem I/O is significantly slower.
Native Windows binary (windows-amd64.zip + install.ps1) is planned for v1.1.0.
Known requirements before v1.1.0 ships:
- Path-separator audit (all
filepath.Joincalls, no hardcoded/) - Windows code-signing certificate ($300+/yr EV cert for SmartScreen bypass)
-
nself completion powershell(already implemented, see above) - Windows CI runner testing (added to CI in v1.0.9 via S49-T01)
Track progress: github.com/nself-org/cli/issues
ɳ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