Skip to content

cmd admin

github-actions[bot] edited this page Oct 14, 2026 · 8 revisions

nself admin

Manage the ɳSelf Admin UI: open, start, stop, inspect logs, or health-check.

Synopsis

nself admin [subcommand] [flags]

Description

nself admin manages the local ɳSelf Admin dashboard at http://localhost:3021. With no subcommand, it opens the dashboard in your default browser. Use subcommands to control the Admin container lifecycle directly.

The Admin UI is a local-only web interface (Docker container) on your machine. It is not a hosted service.

Admin is a builtin plugin family. Use nself remove admin to disable its command and nself add admin to enable it again.

stop

logs

Flags

Name Shorthand Type Default Env Escalates to JSON override Description
--help -h bool false Show help

Subcommands

Name Description
connect Connect to a remote ɳSelf Admin via SSH tunnel
health Check Admin service liveness
logs Tail Admin container logs
projects Manage multi-project admin configuration
serve Serve the authenticated ɳSelf HTTP API
start Start the Admin service
stop Stop the Admin container

Contract

  • Side effect: read
  • Output: document
  • JSON: envelope (data schema)
  • Exit codes: none declared

Examples

# Open the Admin UI in your browser
nself admin

# Start the Admin service (idempotent)
nself admin start

# Stop the Admin container
nself admin stop

# Force-stop immediately
nself admin stop --force

# Tail the last 50 log lines
nself admin logs --tail 50

# Stream logs continuously
nself admin logs --follow

# Check Admin health
nself admin health

See Also

← Commands | Home →

Home


Getting Started


Commands


Features


Configuration


Plugins (87 + 10 monitoring)

Free (25)
Pro (62)
Planned (26)
  • plugin-audit
  • plugin-blog
  • plugin-checkout
  • plugin-commerce
  • plugin-drm
  • plugin-export
  • plugin-flow
  • plugin-import
  • plugin-ldap
  • plugin-mailgun
  • plugin-media
  • plugin-oauth-providers
  • plugin-pages
  • plugin-postmark
  • plugin-rate-limit
  • plugin-reports
  • plugin-saml
  • plugin-scheduler
  • plugin-sendgrid
  • plugin-sso
  • plugin-subscription
  • plugin-thumb
  • plugin-transcoder
  • plugin-twilio
  • plugin-waf
  • plugin-watermark

Guides


Architecture


Reference


Machine interface


Licensing


Security


Brand


Operations


Contributing


Admin


Changelog


All commands (21)

Clone this wiki locally