-
-
Notifications
You must be signed in to change notification settings - Fork 2
auth consolidation
Status: Completed Date: January 30, 2026 Version: Command Tree v1.0
All authentication and security-related commands have been consolidated under nself auth with 38 subcommands total. This refactoring follows the Command Tree v1.0 specification to reduce the number of top-level commands from 79 to 31.
nself auth <category> <action> [options]
-
Authentication (3 subcommands)
- login
- logout
- status
-
MFA (4 subcommands)
- mfa enable
- mfa disable
- mfa verify
- mfa backup-codes
-
Roles (4 subcommands)
- roles list
- roles create
- roles assign
- roles remove
-
Devices (4 subcommands)
- devices list
- devices register
- devices revoke
- devices trust
-
OAuth (7 subcommands)
- oauth install
- oauth enable
- oauth disable
- oauth config
- oauth test
- oauth list
- oauth status
-
Security (3 subcommands)
- security scan
- security audit
- security report
-
SSL (5 subcommands)
- ssl generate
- ssl install
- ssl renew
- ssl info
- ssl trust
-
Rate Limiting (3 subcommands)
- rate-limit config
- rate-limit status
- rate-limit reset
-
Webhooks (5 subcommands)
- webhooks create
- webhooks list
- webhooks delete
- webhooks test
- webhooks logs
Total: 38 subcommands
| Old Command | New Command | Status |
|---|---|---|
nself mfa |
nself auth mfa |
✅ Deprecated wrapper active |
nself roles |
nself auth roles |
✅ Deprecated wrapper active |
nself devices |
nself auth devices |
✅ Deprecated wrapper active |
nself oauth |
nself auth oauth |
✅ Deprecated wrapper active |
nself security |
nself auth security |
✅ Deprecated wrapper active |
nself ssl |
nself auth ssl |
✅ Deprecated wrapper active |
nself trust |
nself auth ssl trust |
✅ Deprecated wrapper active |
nself rate-limit |
nself auth rate-limit |
✅ Deprecated wrapper active |
nself webhooks |
nself auth webhooks |
✅ Deprecated wrapper active |
All old commands still work but show deprecation warnings:
$ nself mfa enable --user=123 --method=totp
⚠ WARNING: 'nself mfa' is deprecated. Use 'nself auth mfa' instead.
This compatibility wrapper will be removed in v1.0.0
[command continues normally...]src/cli/
├── auth.sh # Main consolidated command
├── _deprecated/ # Backup directory
│ ├── mfa.sh.backup # Original implementation
│ ├── roles.sh.backup # Original implementation
│ ├── devices.sh.backup # Original implementation
│ ├── oauth.sh.backup # Original implementation
│ ├── security.sh.backup # Original implementation
│ ├── ssl.sh.backup # Original implementation
│ ├── trust.sh.backup # Original implementation
│ ├── rate-limit.sh.backup # Original implementation
│ └── webhooks.sh.backup # Original implementation
├── mfa.sh # Deprecation wrapper
├── roles.sh # Deprecation wrapper
├── devices.sh # Deprecation wrapper
├── oauth.sh # Deprecation wrapper
├── security.sh # Deprecation wrapper
├── ssl.sh # Deprecation wrapper
├── trust.sh # Deprecation wrapper
├── rate-limit.sh # Deprecation wrapper
└── webhooks.sh # Deprecation wrapper
The main auth.sh file:
- Uses
cli-output.shfor consistent output formatting - Implements authentication commands directly (login, logout, status)
- Delegates to original backup implementations for complex subcommands
- Provides comprehensive help text with all 38 subcommands
- Bash 3.2 compatible
Each wrapper file:
- Shows a yellow warning message using ANSI escape codes
- Informs users of the new command syntax
- States when the wrapper will be removed (v1.0.0)
- Delegates to the new
nself auth <category>command usingexec
Example deprecation message:
⚠ WARNING: 'nself mfa' is deprecated. Use 'nself auth mfa' instead.
This compatibility wrapper will be removed in v1.0.0The auth.sh command delegates to original implementations stored in _deprecated/:
cmd_auth_mfa() {
local action="${1:-}"
shift
# Delegate to original implementation
if [[ -f "$SCRIPT_DIR/_deprecated/mfa.sh.backup" ]]; then
bash "$SCRIPT_DIR/_deprecated/mfa.sh.backup" "$action" "$@"
else
cli_error "MFA module not found"
exit 1
fi
}# MFA management
nself mfa enable --user=123 --method=totp
nself mfa verify --user=123 --code=123456
# OAuth setup
nself oauth install
nself oauth config google --client-id=xxx --client-secret=yyy
# SSL certificates
nself ssl bootstrap
nself trust
# Rate limiting
nself rate-limit check ip 192.168.1.1# MFA management
nself auth mfa enable --user=123 --method=totp
nself auth mfa verify --user=123 --code=123456
# OAuth setup
nself auth oauth install
nself auth oauth config google --client-id=xxx --client-secret=yyy
# SSL certificates
nself auth ssl generate
nself auth ssl trust
# Rate limiting
nself auth rate-limit check ip 192.168.1.1- Logical Grouping: All auth/security commands under one namespace
-
Discoverability: Users can explore all security features with
nself auth --help - Consistency: Follows Command Tree v1.0 pattern used across nself
- Backward Compatible: Old commands still work during transition period
- Clear Migration Path: Deprecation warnings guide users to new syntax
The auth command uses the standardized cli-output.sh library:
-
cli_success()- Success messages with ✓ icon -
cli_error()- Error messages with ✗ icon -
cli_warning()- Warning messages with ⚠ icon -
cli_info()- Info messages with ℹ icon - Cross-platform compatible (Bash 3.2+)
- Respects
NO_COLORenvironment variable
To test the consolidated commands:
# View all auth commands
nself auth --help
# Test delegation to subcommands
nself auth mfa help
nself auth oauth list
nself auth ssl status
# Test backward compatibility (shows deprecation warning)
nself mfa help
nself oauth help- v0.6.x - v0.9.x: Deprecation warnings active, old commands work
-
v1.0.0: Remove all deprecation wrappers, only
nself authworks
- Command Tree v1.0
- CLI Output Library (
src/lib/utils/cli-output.sh) - Auth Command Reference
Last Updated: January 30, 2026
ɳ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