Repository navigation
MCP Tools
The tools nself mcp serves in v1.5 mode, one per exposed command of the machine registry, with no plugin installed. Each tool takes args, flags and confirm; the input schema link opens the tool's entry in the committed tool list. A call that needs confirmation returns confirmation_required first; repeat the identical call with confirm set. Confirm required follows the invoker's gate: yes for a remote or destructive command, no for a read command or a write command with no plan form, with --flag when only that exposed flag raises the side effect to remote or destructive, and if the plan requires it for a write command with a plan form, which asks only when its plan says so.
| Name | Summary | Side effect | Confirm required | Input schema |
|---|---|---|---|---|
nself_add |
Install a plugin or bundle | remote |
yes | input schema |
nself_admin |
Manage the nSelf Admin dashboard | read |
no | input schema |
nself_admin_health |
Check Admin service liveness | read |
no | input schema |
nself_admin_logs |
Tail Admin container logs | read |
no | input schema |
nself_admin_projects |
Manage multi-project admin configuration | read |
no | input schema |
nself_admin_projects_add |
Add a project to the admin multi-project config | write |
no | input schema |
nself_admin_projects_list |
List configured admin projects | read |
no | input schema |
nself_admin_projects_remove |
Remove a project from admin config | write |
no | input schema |
nself_admin_start |
Start the Admin service | write |
no | input schema |
nself_admin_stop |
Stop the Admin container | write |
no | input schema |
nself_backup |
Backup operations: create, list, restore, verify, prune, config, status, init-key | read |
no | input schema |
nself_backup_config |
View backup configuration | write |
no | input schema |
nself_backup_create |
Create a new backup | remote |
no | input schema |
nself_backup_drill |
Run a DR drill: restore latest backup into scratch DB and measure RTO | write |
no | input schema |
nself_backup_init_key |
Generate age encryption keypair for backups | write |
no | input schema |
nself_backup_list |
List available backups | read |
no | input schema |
nself_backup_pitr |
Point-in-time recovery: enable, disable, status, base-backup, restore | read |
no | input schema |
nself_backup_pitr_base_backup |
Take a manual pg_basebackup snapshot now | write |
no | input schema |
nself_backup_pitr_disable |
Stop WAL archiving (removes PITR config snippet) | write |
no | input schema |
nself_backup_pitr_enable |
Configure WAL archiving and enable PITR | write |
no | input schema |
nself_backup_pitr_restore |
Restore database to a specific point in time | destructive |
yes | input schema |
nself_backup_pitr_status |
Show PITR retention window, segment count, and latest WAL timestamp | read |
no | input schema |
nself_backup_prune |
Remove old backups by retention policy | destructive |
yes | input schema |
nself_backup_restore |
Restore from a backup | destructive |
yes | input schema |
nself_backup_restore_remote |
Restore a backup directly from a remote URL | destructive |
yes | input schema |
nself_backup_resume |
Resume an interrupted streaming backup | write |
no | input schema |
nself_backup_schedule |
Schedule recurring streaming backups via systemd timers | write |
no | input schema |
nself_backup_status |
Show backup subsystem status | read |
no | input schema |
nself_backup_verify |
Verify backup integrity | write |
no | input schema |
nself_build |
Compose your infrastructure from .env | write |
if the plan requires it | input schema |
nself_capabilities |
Search commands and plugins by what you want to do. Same as nself_help_capabilities with a single query string. | read |
no | input schema |
nself_clean |
Remove generated artifacts (docker-compose.yml, nginx configs, build cache) | destructive |
with --all
|
input schema |
nself_config |
Manage project configuration | read |
no | input schema |
nself_config_bundles |
Manage and inspect nSelf plugin bundles | read |
no | input schema |
nself_config_bundles_info |
Show bundle details, plugins, and license status | read |
no | input schema |
nself_config_bundles_install |
Install every plugin in a bundle (license-gated, atomic rollback on failure) | write |
no | input schema |
nself_config_bundles_list |
List all available nSelf plugin bundles | read |
no | input schema |
nself_config_env |
Multi-environment management: switch, list, diff, copy | read |
no | input schema |
nself_config_env_copy |
Scaffold a new environment from an existing one | write |
no | input schema |
nself_config_env_diff |
Compare two environment configs side-by-side | read |
no | input schema |
nself_config_env_explain |
Show the effective .env cascade and which file wins | read |
no | input schema |
nself_config_env_list |
List available environments | read |
no | input schema |
nself_config_env_show |
Show current environment config (secrets redacted) | read |
no | input schema |
nself_config_env_target |
Manage control-plane server targets | read |
no | input schema |
nself_config_env_target_add |
Add a server to an environment | remote |
yes | input schema |
nself_config_env_target_list |
List servers in the control-plane inventory | read |
no | input schema |
nself_config_env_target_migrate |
Migrate legacy NSELF_DEPLOY_HOST_* env vars to control-plane.yaml | write |
no | input schema |
nself_config_env_target_probe |
Resolve runtime capability for one or more targets | read |
no | input schema |
nself_config_env_target_remove |
Remove a server from an environment | write |
no | input schema |
nself_config_env_use |
Switch active environment | write |
no | input schema |
nself_config_explain |
Explain where a configuration key comes from | read |
no | input schema |
nself_config_features |
Manage CLI-built-in feature flags | read |
no | input schema |
nself_config_features_disable |
Disable a feature flag (records an override) | write |
no | input schema |
nself_config_features_enable |
Enable a feature flag (records an override) | write |
no | input schema |
nself_config_features_list |
List all registered feature flags with effective state | read |
no | input schema |
nself_config_features_status |
Show the effective state for a single flag | read |
no | input schema |
nself_config_get |
Get a single configuration value | read |
no | input schema |
nself_config_import |
Import config from a file into .env | destructive |
with --force
|
input schema |
nself_config_list |
List all known config keys with current values | read |
no | input schema |
nself_config_oauth |
Manage OAuth provider tokens | read |
no | input schema |
nself_config_oauth_refresh |
Trigger immediate OAuth token refresh for a provider | remote |
yes | input schema |
nself_config_plugins_audit_tables |
Audit np_* table row counts and multi-tenant isolation compliance | read |
no | input schema |
nself_config_plugins_compat_check |
Check installed plugins against the current CLI version | read |
no | input schema |
nself_config_plugins_count |
Show the authoritative plugin counts (free, pro, advertised) | read |
no | input schema |
nself_config_plugins_disable |
Disable a plugin (excluded from compose on next build) | write |
no | input schema |
nself_config_plugins_enable |
Re-enable a previously disabled plugin | write |
no | input schema |
nself_config_plugins_info |
Show detailed plugin information | read |
no | input schema |
nself_config_plugins_inventory |
List installed plugins with version, tier, and status | read |
no | input schema |
nself_config_plugins_list |
List available and installed plugins | read |
no | input schema |
nself_config_plugins_outdated |
List installed plugins with a newer version available | read |
no | input schema |
nself_config_plugins_refresh |
Force refresh the registry cache | write |
no | input schema |
nself_config_plugins_search |
Search plugins by name, description, or tag | read |
no | input schema |
nself_config_plugins_start |
Start a plugin service | write |
no | input schema |
nself_config_plugins_status |
Show plugin status | read |
no | input schema |
nself_config_plugins_stop |
Stop a plugin service | write |
no | input schema |
nself_config_plugins_update |
Update a specific plugin or all plugins | write |
no | input schema |
nself_config_plugins_updates |
Check for available plugin updates | read |
no | input schema |
nself_config_secrets |
Manage encrypted project secrets (age encryption) | read |
no | input schema |
nself_config_secrets_audit |
Report secrets that haven't been rotated in >90 days | read |
no | input schema |
nself_config_secrets_init |
Generate age key and set up .secrets/ directory | write |
no | input schema |
nself_config_secrets_lint |
Check for plaintext secrets in git-tracked files | read |
no | input schema |
nself_config_secrets_list |
List all secrets for an environment | read |
no | input schema |
nself_config_secrets_list_schedules |
List all rotation schedule statuses (alias for: secrets schedule) | read |
no | input schema |
nself_config_secrets_recipients |
Manage age recipients of one secret store | read |
no | input schema |
nself_config_secrets_rekey |
Re-encrypt all secrets, removing a team member's key | destructive |
yes | input schema |
nself_config_secrets_retire |
Retire the _PREVIOUS variant of a dual-window rotated secret | destructive |
yes | input schema |
nself_config_secrets_rotate |
Rotate a secret to a new value | destructive |
yes | input schema |
nself_config_secrets_rotation_log |
Show rotation event log | read |
no | input schema |
nself_config_secrets_schedule |
Add a rotation schedule or show all schedule statuses | write |
no | input schema |
nself_config_secrets_set |
Set a secret value (prompts if value not provided) | destructive |
yes | input schema |
nself_config_secrets_verify |
Verify that a named secret exists in the store | read |
no | input schema |
nself_config_services |
Manage optional services | read |
no | input schema |
nself_config_services_add |
Scaffold a custom service (CS_N slot) into the current project | write |
no | input schema |
nself_config_services_configure |
Configure service settings (e.g. email provider presets) | write |
no | input schema |
nself_config_services_disable |
Disable an optional service | write |
no | input schema |
nself_config_services_enable |
Enable an optional service | write |
no | input schema |
nself_config_services_list |
List all optional services with enabled/disabled status | read |
no | input schema |
nself_config_services_ps |
Show status of all nSelf stack services | read |
no | input schema |
nself_config_services_restart |
Restart a named nSelf service | write |
no | input schema |
nself_config_services_scale |
Set the replica count for a named service | write |
no | input schema |
nself_config_services_start |
Start a named nSelf service | write |
no | input schema |
nself_config_services_stop |
Stop a named nSelf service (container preserved) | write |
no | input schema |
nself_config_services_update |
Pull the latest image for a service and restart it | write |
no | input schema |
nself_config_services_upgrade |
Pin a service to a specific image version | write |
no | input schema |
nself_config_set |
Update a configuration value (writes to .env) | destructive |
yes | input schema |
nself_config_show |
Show all config key=value pairs (masked by default) | read |
no | input schema |
nself_config_telemetry |
Manage CLI telemetry preferences | read |
no | input schema |
nself_config_telemetry_off |
Disable telemetry (writes to ~/.nself/config.toml) | write |
no | input schema |
nself_config_telemetry_on |
Enable telemetry (writes to ~/.nself/config.toml) | write |
no | input schema |
nself_config_telemetry_status |
Show current telemetry state and anonymous install-ID | read |
no | input schema |
nself_config_trust_ssl |
Manage SSL certificates | read |
no | input schema |
nself_config_trust_ssl_add |
Provision an SSL certificate for a single domain | remote |
yes | input schema |
nself_config_trust_ssl_renew |
Renew SSL certificates and reload the serving proxy | remote |
yes | input schema |
nself_config_trust_ssl_setup |
Set up SSL certificates via DNS-01 challenge | remote |
yes | input schema |
nself_config_trust_ssl_status |
Show SSL certificate status | read |
no | input schema |
nself_config_trust_status |
Show trusted cert CAs, last rotation date, and expiry warnings | read |
no | input schema |
nself_config_validate |
Validate configuration against all registered rules | read |
no | input schema |
nself_db |
Database operations: migrations, backups, restore, seed, shell | read |
no | input schema |
nself_db_backup |
Create pg_dump backup | write |
no | input schema |
nself_db_backup_list |
List available backups with size and date | read |
no | input schema |
nself_db_backup_sync |
Sync local backups to remote storage (cross-region) | remote |
yes | input schema |
nself_db_backup_sync_status |
Show cross-region backup sync status | read |
no | input schema |
nself_db_drift |
Schema drift detection: scan np_* tables for Theme 25 column compliance | read |
no | input schema |
nself_db_drift_fix |
Generate migration SQL to fix Theme 25 column drift | write |
no | input schema |
nself_db_drift_scan |
Scan np_* tables for missing Theme 25 columns | read |
no | input schema |
nself_db_drop |
Drop the project database (DESTRUCTIVE) | destructive |
yes | input schema |
nself_db_export |
Export a portable bundle from a started project | read |
no | input schema |
nself_db_fk_index |
Audit and create indexes for foreign key columns | read |
no | input schema |
nself_db_fk_index_apply |
Create missing FK indexes | write |
no | input schema |
nself_db_fk_index_audit |
Find FK columns without supporting indexes | read |
no | input schema |
nself_db_generate |
Generate type-safe client SDK types from the live Hasura schema | write |
no | input schema |
nself_db_generate_vector_search |
Generate a k-NN search function for a vector column and track it in Hasura | write |
no | input schema |
nself_db_hasura |
Hasura metadata operations | read |
no | input schema |
nself_db_hasura_apply_ref |
Apply Hasura metadata from a specific git ref | write |
no | input schema |
nself_db_hasura_console |
Open Hasura Console | read |
no | input schema |
nself_db_hasura_diff |
Compare live Hasura metadata against on-disk files | read |
no | input schema |
nself_db_hasura_git_status |
Show git status of the hasura/metadata/ directory | read |
no | input schema |
nself_db_hasura_metadata |
Manage Hasura metadata | read |
no | input schema |
nself_db_hasura_metadata_apply |
Apply Hasura metadata | remote |
no | input schema |
nself_db_hasura_metadata_drift |
Detect drift between live Hasura metadata and committed files | read |
no | input schema |
nself_db_hasura_metadata_export |
Export Hasura metadata to git-friendly sorted YAML | write |
no | input schema |
nself_db_hasura_metadata_reload |
Reload metadata cache | write |
no | input schema |
nself_db_hasura_permissions |
Read Hasura table permissions | read |
no | input schema |
nself_db_hasura_schema |
Read the Hasura GraphQL schema | read |
no | input schema |
nself_db_hasura_snapshot |
Capture or compare Hasura metadata snapshots | write |
no | input schema |
nself_db_hasura_sync |
Export live Hasura metadata and commit to git | write |
no | input schema |
nself_db_hasura_validate |
Validate Hasura metadata consistency and permission coverage | read |
no | input schema |
nself_db_image_switch |
Move the database to the pgvector Postgres image (the old volume is kept) | destructive |
yes | input schema |
nself_db_import_appwrite |
Import and verify data from appwrite | write |
no | input schema |
nself_db_import_firebase |
Generate nSelf migration artifacts from a Firebase export | write |
no | input schema |
nself_db_import_hasura_cloud |
Import and verify data from hasura-cloud | write |
no | input schema |
nself_db_import_nhost |
Import and verify data from nhost | write |
no | input schema |
nself_db_import_nself |
Import and verify a portable bundle written by nself db export
|
write |
no | input schema |
nself_db_import_postgres |
Import and verify data from postgres | write |
no | input schema |
nself_db_import_supabase |
Migrate a Supabase project to nSelf | write |
no | input schema |
nself_db_lint |
Check RLS policies on tenant-scoped tables | read |
no | input schema |
nself_db_list |
List databases in the project Postgres instance | read |
no | input schema |
nself_db_migrate |
Manage database migrations | read |
no | input schema |
nself_db_migrate_apply |
Apply a specific migration file (G-008) | write |
no | input schema |
nself_db_migrate_audit |
Audit migrations for idempotency, rollback files, and checksum drift | read |
no | input schema |
nself_db_migrate_baseline |
Record migration(s) as applied WITHOUT running their SQL | write |
no | input schema |
nself_db_migrate_create |
Create new migration file | write |
no | input schema |
nself_db_migrate_down |
Revert last migration | destructive |
yes | input schema |
nself_db_migrate_generate |
Generate a SQL migration from a natural-language description | write |
no | input schema |
nself_db_migrate_idempotent |
Check and optionally rewrite a migration file to be idempotent | write |
no | input schema |
nself_db_migrate_lint |
Refuse migrations with many unguarded CREATE TABLE statements | read |
no | input schema |
nself_db_migrate_status |
Show migration status | read |
no | input schema |
nself_db_migrate_up |
Apply pending migrations | remote |
no | input schema |
nself_db_pgbouncer |
PgBouncer connection pooler operations | read |
no | input schema |
nself_db_pgbouncer_generate |
Write PgBouncer config files to .nself/pgbouncer/ | write |
no | input schema |
nself_db_pgbouncer_status |
Show PgBouncer runtime status (SHOW STATS via psql) | read |
no | input schema |
nself_db_pitr |
Point-in-time recovery: status, enable, test, restore | read |
no | input schema |
nself_db_pitr_enable |
Write PITR configuration to .nself/pitr/ | write |
no | input schema |
nself_db_pitr_restore |
Restore database to a point in time (--target RFC3339) | destructive |
yes | input schema |
nself_db_pitr_status |
Show PITR/WAL archiving status | read |
no | input schema |
nself_db_pitr_test |
Verify WAL archiving is working | write |
no | input schema |
nself_db_reconcile |
Push repo-declared Hasura metadata (permissions, relationships, table tracking) to a live instance | write |
no | input schema |
nself_db_reset |
Drop and recreate database (DESTRUCTIVE) | destructive |
yes | input schema |
nself_db_reset_checksum |
Reset stored checksum for a migration (dangerous) | destructive |
yes | input schema |
nself_db_restore |
Restore from backup | destructive |
yes | input schema |
nself_db_restore_drill |
Run a non-destructive restore drill | write |
no | input schema |
nself_db_restore_drill_list |
List past restore drill results | read |
no | input schema |
nself_db_rls |
Row-Level Security management: audit, apply, rollback | read |
no | input schema |
nself_db_rls_apply |
Enable RLS and apply default policies on tables that are missing them | write |
no | input schema |
nself_db_rls_apply_table |
Enable RLS and apply default policies on a specific table | write |
no | input schema |
nself_db_rls_audit |
List tables with their RLS and policy state | read |
no | input schema |
nself_db_rls_rollback |
Print rollback SQL that removes RLS policies and disables RLS | read |
no | input schema |
nself_db_seed |
Database seeding: run, list, verify, graph | write |
no | input schema |
nself_db_seed_fixtures |
Manage seed fixtures | read |
no | input schema |
nself_db_seed_fixtures_list |
List available fixtures | read |
no | input schema |
nself_db_seed_fixtures_manifest |
Show or store a fixture manifest | write |
no | input schema |
nself_db_seed_fixtures_run |
Run a specific fixture | write |
no | input schema |
nself_db_seed_fixtures_verify |
Verify fixture checksums against a stored manifest | read |
no | input schema |
nself_db_seed_graph |
Show seed dependency graph | read |
no | input schema |
nself_db_seed_list |
List available seeds and fixtures | read |
no | input schema |
nself_db_seed_matrix |
Show the seed environment/file matrix | read |
no | input schema |
nself_db_seed_run |
Execute seeds for current environment | destructive |
no | input schema |
nself_db_seed_verify |
Verify a fixture is deterministic (dry-run replay check) | read |
no | input schema |
nself_db_soft_delete |
Manage soft-delete (deleted_at) patterns across tables | read |
no | input schema |
nself_db_soft_delete_apply |
Add deleted_at column, index, and active view to a table | write |
no | input schema |
nself_db_soft_delete_audit |
Audit tables for soft-delete status | read |
no | input schema |
nself_db_soft_delete_generate |
Print soft-delete migration SQL to stdout | write |
no | input schema |
nself_db_verify |
Verify what a Hasura role can actually reach via role-scoped introspection | read |
no | input schema |
nself_db_verify_checksums |
Verify migration file checksums against stored values | read |
no | input schema |
nself_deploy |
Deploy the stack to a target environment | remote |
yes | input schema |
nself_deploy_access |
Manage SSH key access on an already-deployed server | read |
no | input schema |
nself_deploy_access_grant |
Grant a person SSH key access to a host | remote |
yes | input schema |
nself_deploy_access_list |
List who has SSH key access to a host | read |
no | input schema |
nself_deploy_access_revoke |
Revoke a person's SSH key access to a host | remote |
yes | input schema |
nself_deploy_check_access |
Verify access to configured deploy targets (deprecated: use 'nself env target probe') | read |
no | input schema |
nself_deploy_environments |
List configured deploy environments and server capabilities | read |
no | input schema |
nself_deploy_health |
Run health checks against a target deployment | read |
no | input schema |
nself_deploy_ops |
Deploy with the ops profile to the ops server | remote |
yes | input schema |
nself_deploy_promote |
Promote a canary or an environment | remote |
yes | input schema |
nself_deploy_promote_env |
Promote one environment to another (e.g. staging to prod) | remote |
yes | input schema |
nself_deploy_promote_env_rollback |
Rollback to pre-promotion backup | destructive |
yes | input schema |
nself_deploy_rollback |
Roll back the last deployment for a target | destructive |
yes | input schema |
nself_deploy_security_setup |
Apply baseline server hardening | read |
no | input schema |
nself_deploy_status |
Show deployment status for a target | read |
no | input schema |
nself_deploy_targets |
List deploy targets without connecting to them | read |
no | input schema |
nself_deploy_web |
Build web apps locally and deploy prebuilt output to Vercel | remote |
yes | input schema |
nself_doctor |
Run comprehensive system diagnostics | write |
no | input schema |
nself_doctor_heal |
Run targeted self-healing routines for nSelf components | write |
no | input schema |
nself_doctor_images |
Check availability of every locked image | read |
no | input schema |
nself_doctor_report |
Write a redacted support bundle (tar.gz) to share in an issue | read |
no | input schema |
nself_doctor_security_audit |
Run a read-only security audit | read |
no | input schema |
nself_doctor_security_status |
Show current security posture | read |
no | input schema |
nself_help_capabilities |
Search commands and plugins by what you want to do | read |
no | input schema |
nself_help_topics |
Moved to nself help topics | read |
no | input schema |
nself_init |
Initialize a new nSelf project | write |
no | input schema |
nself_init_template |
Browse and publish full-stack app templates | read |
no | input schema |
nself_init_template_info |
Show detail for a single template | read |
no | input schema |
nself_init_template_list |
List available app templates | read |
no | input schema |
nself_init_template_publish |
Submit a template to the nSelf registry | remote |
yes | input schema |
nself_init_template_update |
Apply incremental migrations for the installed template | destructive |
no | input schema |
nself_license |
Manage license keys for nSelf product bundles | read |
no | input schema |
nself_license_account |
Manage your nSelf account, sessions, licenses, team, and devices | read |
no | input schema |
nself_license_account_devices |
List and revoke registered devices | read |
no | input schema |
nself_license_account_licenses |
List and manage account licenses | read |
no | input schema |
nself_license_account_status |
Show current account summary | read |
no | input schema |
nself_license_account_team |
Manage team members | read |
no | input schema |
nself_license_add |
Add one or more license keys | write |
no | input schema |
nself_license_clear |
Remove all saved license keys | destructive |
yes | input schema |
nself_license_health |
Validate format, ping server, and report cache integrity | read |
no | input schema |
nself_license_import |
Import a previously exported license cache file | write |
no | input schema |
nself_license_list |
Show all configured licenses (alias for status) | read |
no | input schema |
nself_license_migrate |
Migrate legacy license key to a nSelf account | remote |
yes | input schema |
nself_license_refresh |
Force-refresh license validation against ping.nself.org | write |
no | input schema |
nself_license_remove |
Remove a license key by value or product name | destructive |
yes | input schema |
nself_license_restore |
Reactivate dormant plugins with a new license key | write |
no | input schema |
nself_license_revalidate |
Force a fresh validation against ping.nself.org and update the cache | write |
no | input schema |
nself_license_revoke |
Mark local license as revoked and wipe the stored key | destructive |
yes | input schema |
nself_license_set |
Replace all keys with a single key | destructive |
yes | input schema |
nself_license_show |
Display license tier, bundles, plugins, and cache expiry | read |
no | input schema |
nself_license_simulate_offline |
Simulate being offline for N days (testing only) | write |
no | input schema |
nself_license_status |
Show all configured licenses and plugin coverage | read |
no | input schema |
nself_license_upgrade |
Open pricing page in browser | read |
no | input schema |
nself_license_validate |
Validate key against ping.nself.org | read |
no | input schema |
nself_logs |
View and filter service logs | read |
no | input schema |
nself_mcp_setup |
Print or write the MCP client config and AGENTS.md for this project | write |
no | input schema |
nself_remove |
Remove an installed plugin or bundle | destructive |
yes | input schema |
nself_reset |
Stop containers, remove all data volumes, and clean generated files | destructive |
yes | input schema |
nself_restart |
Smart restart with config change detection | write |
no | input schema |
nself_start |
Boot your nSelf stack | write |
no | input schema |
nself_status |
Show health status of all services | read |
no | input schema |
nself_status_health |
Health check management with continuous monitoring | read |
no | input schema |
nself_status_health_check |
Run all health checks | read |
no | input schema |
nself_status_health_config |
Show health check settings | read |
no | input schema |
nself_status_health_endpoint |
Check an HTTP endpoint | read |
no | input schema |
nself_status_health_history |
Show last 20 health checks | read |
no | input schema |
nself_status_health_service |
Check a single service | read |
no | input schema |
nself_status_urls |
Display all service URLs with route conflict detection | read |
no | input schema |
nself_stop |
Gracefully shut down all services or specific services | destructive |
with --volumes
|
input schema |
nself_update |
Update the nSelf CLI and admin UI | write |
no | input schema |
nself_update_images |
Refresh Docker image digests from registries | write |
no | input schema |
nself_update_project_detect |
Detect v1 artifacts in the current project | read |
no | input schema |
nself_update_project_from_bash |
Migrate a v0.9.9 Bash-era project to the current nSelf CLI | write |
no | input schema |
nself_update_project_from_v099 |
Migrate v0.9.9 home-level state (license key, channel, ssh keys) to v1.x layout | write |
no | input schema |
nself_update_project_rollback |
Restore a v1 backup created by migrate run | destructive |
yes | input schema |
nself_update_project_run |
Migrate v1 project to v2 | write |
no | input schema |
nself_update_stack |
Upgrade the stack with a verified backup and resumable steps | destructive |
yes | input schema |
nself_update_upgrade |
Upgrade the nSelf CLI (detects install method) | write |
no | input schema |
nself_update_verify_sbom |
Verify the SBOM signature for a CLI release | read |
no | input schema |
Deprecated names from v1.4, removed in v1.6.0. Each maps its parameters onto the canonical tool in its summary.
| Name | Summary | Side effect | Confirm required | Input schema |
|---|---|---|---|---|
nself_env_list |
Deprecated: use nself_config_env_list; removed in v1.6.0. List available environments. | read |
no | input schema |
nself_get_permissions |
Deprecated: use nself_db_hasura_permissions; removed in v1.6.0. Read Hasura table permissions. | read |
no | input schema |
nself_get_schema |
Deprecated: use nself_db_hasura_schema; removed in v1.6.0. Read the Hasura GraphQL schema. | read |
no | input schema |
nself_plugin_install |
Deprecated: use nself_add; removed in v1.6.0. Install a plugin or bundle. | remote |
no | input schema |
nself_plugin_list |
Deprecated: use nself_config_plugins_list; removed in v1.6.0. List available and installed plugins. | read |
no | input schema |
nself_run_migration |
Deprecated: removed in v1.5. nself_run_migration ran raw SQL outside the migration ledger and is removed in v1.5; use nself db migrate create then nself db migrate up. | destructive |
no | input schema |
nself_service_list |
Deprecated: use nself_config_services_list; removed in v1.6.0. List all optional services with enabled/disabled status. | read |
no | input schema |
nself_urls |
Deprecated: use nself_status_urls; removed in v1.6.0. Display all service URLs with route conflict detection. | read |
no | input schema |
sentry_incidents_ack |
Deprecated: use nself_sentry_incidents_ack; removed in v1.6.0. Acknowledge an ɳSentry incident. | write |
no | input schema |
sentry_incidents_list |
Deprecated: use nself_sentry_incidents_list; removed in v1.6.0. List ɳSentry incidents. | read |
no | input schema |
sentry_monitors_add |
Deprecated: use nself_sentry_monitors_add; removed in v1.6.0. Add an ɳSentry uptime monitor. | write |
no | input schema |
sentry_monitors_list |
Deprecated: use nself_sentry_monitors_list; removed in v1.6.0. List ɳSentry uptime monitors. | read |
no | input schema |
sentry_status |
Deprecated: use nself_sentry_status; removed in v1.6.0. Read the public ɳSentry status. | read |
no | input schema |
Plugin commands. Installed plugins add tools by the same ToolName rule. This page is generated from the builtin registry alone, so it never lists them; each plugin's wiki page lists its own in its machine-surface region, for example the CI plugin page.
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-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
- Shared-Proxy
- Config-Optional-Services
- Config-Custom-Services
- Config-System
Plugins (87 + 10 monitoring)
- Plugin-Overview
- Plugin-Catalog
- Plugin-Install
- Plugin-Licensing
- Plugin-Architecture
- Plugin-Dev-Guide
- Plugin-Migrations-Contract
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-analytics
- plugin-auth
- 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-ddns
- plugin-devices
- plugin-documents
- plugin-entitlements
- 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-object-storage
- plugin-observability
- plugin-photos
- plugin-podcast
- plugin-post
- plugin-realtime
- plugin-retro-gaming
- plugin-rom-discovery
- plugin-social
- plugin-sports
- 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
- Architecture
- Architecture-Guardrails
- Service-Graph
- Compose-Generation
- Nginx-Generation
- Plugin-Architecture
Reference
Machine interface
-
JSON-Output,
--jsonenvelope -
Command-Registry,
nself help --json - Exit-Codes
- error-codes, Error Codes
-
Compat-V15,
NSELF_V15gate
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 (21)
- A: cmd-add · cmd-admin
- B: cmd-backup · cmd-build
- C: cmd-clean · cmd-config
- D: cmd-db · cmd-deploy · cmd-doctor
- E: cmd-exec
- I: cmd-init
- L: cmd-license · cmd-logs
- M: cmd-mcp
- R: cmd-remove · cmd-reset · cmd-restart
- S: cmd-start · cmd-status · cmd-stop
- U: cmd-update