-
-
Notifications
You must be signed in to change notification settings - Fork 2
cmd license
Manage your ɳSelf Pro membership license key.
nself license <subcommand> [flags]
nself license manages the Pro membership license key used to install paid plugins. The key is stored locally at ~/.nself/license/key with permissions 0600 (readable only by the current user).
Set your key once with nself license set and all subsequent nself plugin install commands for Pro plugins will use it automatically. The key is validated server-side against ping.nself.org, the CLI does not decode or verify the key locally.
Key format: One of four accepted prefixes followed by 32 or more characters:
-
nself_pro_*, Pro tier -
nself_max_*, Pro tier -
nself_ent_*, Enterprise tier -
nself_owner_*, Owner tier
Keys are validated with a POST request to https://ping.nself.org/license/validate.
When the ɳClaw plugin is running and NSELF_LICENSE_TIER is configured, the claw service automatically seeds a per-user AI spending budget on startup based on your license tier:
| Tier | Monthly AI budget cap |
|---|---|
| Free | $1.00 |
| Basic | $5.00 |
| Pro | $10.00 |
| Elite | $25.00 |
| Business | $50.00 |
| Business+ | $100.00 |
| Enterprise | Unlimited |
The budget is seeded with source='tier_default'. If you have manually set a budget via nself ai budget set --cap <amount>, the manual override is preserved and the tier default is NOT applied. Set NSELF_LICENSE_TIER in your .env.dev or .env.prod to enable this behavior.
Stream live license validation events from ping.nself.org in real time.
| Flag | Default | Description |
|---|---|---|
--filter <field=value> |
— | Filter events (repeatable) |
--ping-url <url> |
$NSELF_PING_URL or https://ping.nself.org
|
ping_api base URL |
| Filter | Example | Description |
|---|---|---|
result=<value> |
result=denied |
Show only allow, deny, or rate_limit events |
key=<prefix> |
key=nself_pro_abc |
Show events for a specific key (first 12 chars matched) |
plugin=<name> |
plugin=ai |
Show events for a specific plugin |
| Color | Meaning |
|---|---|
| Green | allow |
| Red | deny |
| Yellow | rate_limit |
Colors are only shown when output is a terminal. Piped output is plain text.
- Starts streaming within 2s of invocation
- Reconnects automatically on connection loss (exponential backoff, max 30s)
- Ctrl-C exits cleanly with no goroutine leak
- License key values are never shown in full, only the first 12 characters (key prefix) are displayed
# Stream all validation events
nself license tail
# Show only denied validations
nself license tail --filter result=denied
# Show events for a specific key prefix
nself license tail --filter key=nself_pro_abc123
# Combine filters
nself license tail --filter result=denied --filter plugin=ai| Flag | Default | Description |
|---|---|---|
--help, -h
|
— | Show help |
| Name | Description |
|---|---|
add |
Add one or more license keys |
clear |
Remove all saved license keys |
export |
Export signed license cache for air-gap transfer |
health |
Validate format, ping server, and report cache integrity |
import |
Import a previously exported license cache file |
list |
Show all configured licenses (alias for status) |
migrate |
Migrate legacy license key to a ɳSelf account |
refresh |
Force-refresh license validation against ping.nself.org |
remove |
Remove a license key by value or product name |
restore |
Reactivate dormant plugins with a new license key |
revalidate |
Force a fresh validation against ping.nself.org and update the cache |
revoke |
Mark local license as revoked and wipe the stored key |
set |
Replace all keys with a single key |
show |
Display license tier, bundles, plugins, and cache expiry |
simulate-offline |
Simulate being offline for N days (testing only) |
status |
Show all configured licenses and plugin coverage |
tail |
Stream live license validation events from ping_api |
upgrade |
Open pricing page in browser |
validate |
Validate key against ping.nself.org |
# Save your license key
nself license set nself_pro_xxxxx...
# Check what key is saved and its tier
nself license show
# Validate the key is still active
nself license validate
# Remove the saved key
nself license clear
# Open the pricing page to upgrade
nself license upgradeSample show output:
License key: nself_pro_****************************xxxx
Tier: Pro
Status: ✓ active
Stored at: ~/.nself/license/key
- Commands — full command index
- Core-Services — what a stack is made of
ɳ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