Skip to content

cmd add

github-actions[bot] edited this page Oct 18, 2026 · 5 revisions

nself add

Install a plugin or bundle.

Synopsis

nself add <name> [name...] [flags]

Description

Install a plugin or bundle by name.

This is the short form of nself add, with bundle awareness: if the name is a bundle (nchat, nclaw, ntv, nfamily, clawde, nsentry) the whole bundle is installed, otherwise the name is resolved as a plugin.

Third-party plugins install by URL rather than by name:

nself add https://example.com/my-plugin.tar.gz

Once installed, the plugin's commands are available directly:

nself add waf nself waf status

Flags

Name Shorthand Type Default Env Escalates to JSON override Description
--allow-downgrade bool false Install a registry version older than the installed one (v1.5 refuses by default)
--allow-eol bool false Allow installing an EOL plugin (not recommended)
--channel string stable Release channel: stable | beta | canary
--checksum string "" Expected SHA-256 checksum of the downloaded archive (third-party URL installs only)
--dry-run bool false Show what would be installed without making changes
--force bool false Reinstall even when the plugin is already present
--key string "" License key for Licensed plugins
--preview bool false Preview the dependency tree without installing
--show-graph bool false Show dependency graph with topological sort order
--skip-sbom-check bool false Skip SBOM verification (air-gapped installs only — sets NSELF_SKIP_SBOM_CHECK=1)
--strict bool false Fail if any plugin in the bundle is missing from the registry
--tier string "" Force "free" or "licensed" for a slug served as both (e.g. cron, notify); default resolves by license entitlement
--version string "" Install a specific version
--with-optional bool false Include optional dependencies in --preview output
--yes bool false Skip confirmation prompts (required for third-party URL installs in CI)
--help -h bool false Show help

Contract

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

Examples

nself add waf                  # one plugin
  nself add waf cdn analytics    # several at once
  nself add nchat                # a whole bundle

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