Updated for nself v1.0.12 v1.0.12
This complete guide covers all installation methods and platform-specific instructions for ɳSelf, the CLI tool for deploying production-ready backend infrastructure.
ɳSelf is compatible with:
The latest release adds the generate command, account/oauth management, PITR support, RLS audit in nself doctor --deep, and plugin dev tooling. The Security-Always-Free doctrine is now enforced: all hardening runs automatically on every deploy at no charge.
The fastest way to install ɳSelf is using our automated installer:
curl -sSL https://install.nself.org | bashThis single command will:
/usr/local/bin/nselfThe installation script performs these steps:
nself version to confirm successful installationIf you prefer to install manually or need more control over the process:
Visit the ɳSelf releases page and download the appropriate binary for your system:
# Linux x64
wget https://github.com/nself-org/cli/releases/latest/download/nself-linux-x64
# macOS (Intel)
wget https://github.com/nself-org/cli/releases/latest/download/nself-macos-x64
# macOS (Apple Silicon)
wget https://github.com/nself-org/cli/releases/latest/download/nself-macos-arm64
# Windows (WSL2)
wget https://github.com/nself-org/cli/releases/latest/download/nself-windows-x64.exe# Move and rename binary (Linux/macOS)
chmod +x nself-linux-amd64
sudo mv nself-linux-amd64 /usr/local/bin/nselfThe binary is placed directly in /usr/local/bin — no PATH changes needed.
nself versionYou should see output similar to:
nself version 1.0.12ɳSelf requires Docker and Docker Compose to orchestrate your backend services.
# Update package index
sudo apt-get update
# Install dependencies
sudo apt-get install ca-certificates curl gnupg lsb-release
# Add Docker's GPG key
sudo mkdir -m 0755 -p /etc/apt/keyrings
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg
# Set up repository
echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
# Install Docker
sudo apt-get update
sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
# Add user to docker group
sudo usermod -aG docker $USER# Install Docker
sudo dnf install docker docker-compose
# Start and enable Docker
sudo systemctl start docker
sudo systemctl enable docker
# Add user to docker group
sudo usermod -aG docker $USER# Using Homebrew
brew install docker docker-compose
# Or download Docker Desktop from https://docker.com# Check Docker version
docker --version
# Check Docker Compose
docker compose version
# Test Docker (should download and run hello-world)
docker run hello-worldbrew install nself-org/nself/nselfThis installs the latest stable release from the official tap and keeps it up to date with brew upgrade nself.
curl -sSL https://install.nself.org | bashThe script detects your architecture (amd64 or arm64), downloads the appropriate binary, and places it in /usr/local/bin.
After installation, verify ɳSelf is working correctly:
# Check version
nself version
# View help
nself --help
# Check available commands
nself helpCreate a test project to ensure everything works:
# Create test directory
mkdir nself-test && cd nself-test
# Initialize project
nself init
# Build configuration
nself build
# Start services
nself start
# Check status
nself status
# Clean up
nself stop
cd .. && rm -rf nself-testɳSelf stores global configuration in ~/.nself/config.yaml:
# Default settings
auto_update: true
telemetry: false
default_environment: development
docker_socket: unix:///var/run/docker.sock
# Registry settings
registry:
default: docker.io
mirrors: []
# Update settings
updates:
check_interval: 24h
include_prereleases: falseConfigure ɳSelf behavior with environment variables:
# Disable auto-updates
export NSELF_AUTO_UPDATE=false
# Custom Docker socket
export DOCKER_HOST=unix:///var/run/docker.sock
# Debug mode
export NSELF_DEBUG=true
# Custom config location
export NSELF_CONFIG_DIR=$HOME/.config/nselfRun nself update to get the latest version. The update system includes automatic rollback, progress indicators, and version verification. Homebrew users can run brew upgrade nself instead.
ɳSelf can automatically update itself with update system:
# Update to latest version (currently v1.0.12)
nself update
# The update process will:
# 1. Check current version
# 2. Download latest release
# 3. Create backup of current version
# 4. Install new version
# 5. Verify installation
# 6. Rollback if needed
# Check for updates without installing
nself update --check
# Force update even if on latest version
nself update --force# Linux: re-run installer
curl -sSL https://install.nself.org | bash
# macOS (Homebrew)
brew upgrade nselfRemove ɳSelf and all associated data:
# Stop all running services first
nself stop
# Remove binary
sudo rm /usr/local/bin/nself
# Remove local state directory
rm -rf ~/.nself
# macOS (Homebrew)
brew uninstall nself# Fix: Ensure binary is executable
chmod +x /usr/local/bin/nself
# Fix: Confirm nself is on PATH
which nself# Start Docker service
sudo systemctl start docker
# Check Docker status
docker ps# Check if nself is in PATH
which nself
# Reload shell configuration
source ~/.bashrc# Test connectivity
curl -I https://github.com
# Use proxy if needed
export HTTP_PROXY=http://proxy.company.com:8080
export HTTPS_PROXY=http://proxy.company.com:8080Enable debug logging for troubleshooting:
# Enable debug mode
export NSELF_DEBUG=true
# Run command with verbose output
nself --debug version
# Check logs
nself logs --debugIf you encounter issues:
nself logs --debugWhen reporting issues, include:
# Run the built-in diagnostics command
nself doctor
# For a deep check including RLS audit and security hardening:
nself doctor --deepOnce ɳSelf is installed:
Install ɳSelf to a custom location:
# Set custom installation directory
export NSELF_INSTALL_DIR=/opt/nself
# Run installer
curl -sSL https://install.nself.org | bashFor environments without internet access:
For enterprise environments with specific requirements:
# Use enterprise registry
export NSELF_REGISTRY=registry.company.com
# Custom CA certificates
export NSELF_CA_BUNDLE=/path/to/ca-bundle.crt
# Install with enterprise settings
curl -sSL https://install.nself.org | bashThe installation is now complete ɳSelf is ready to help you deploy production-ready backend infrastructure with a single command.