Command reference Every group and command the Notploy CLI exposes — 63 groups, 718 commands.
This reference is generated from the CLI source (packages/cli), so it lists exactly what
notploy 1.0.2 registers with its command parser — no more, no less.
63 groups · 718 commands.
Each group below is a page of this section, and every page lists the commands of that group with
their flags, required inputs and allowed values.
Every command accepts --json to print the raw API response, and
notploy auth — the one command that is not part of the generated groups — is covered in
Authentication .
Group Command Commands Description Operational events notploy operational-event2 Timeline of instance-level events used by alerts, audits and the activity feed. Overview notploy overview3 Aggregated counters for the dashboard: services, backups and domains. Traffic analytics notploy traffic11 Traffic sources and properties, HTTP reports and the audience overview built from access logs.
Group Command Commands Description Deployments notploy deployment11 Inspect deployment history and queues, read deployment logs and kill a running build. Environments notploy environment7 Applications and databases live inside an environment, and environments belong to a project. Projects notploy project11 Create, update, search and remove projects, and read the onboarding state of an instance. Rollbacks notploy rollback2 Roll a deployment back to a previously built image. Tags notploy tag8 Label projects and filter the dashboard by tag.
Group Command Commands Description Applications notploy application32 Create applications, connect a source, configure the build and drive the whole lifecycle. Compose notploy compose31 Docker Compose projects: templates, imports, isolated deployments and previews. Mounts notploy mounts6 Bind mounts and named volumes attached to applications and Compose services. Patches notploy patch12 Versioned file overrides applied to an application at deploy time. Preview deployments notploy preview-deployment4 Per-branch deployments created when preview deployments are enabled. Schedules notploy schedule6 Cron jobs that run a shell command inside a deployed service. Security notploy security4 Per-application HTTP basic auth and response security headers. Vault providers notploy vault-provider13 External secret managers connected to the platform to resolve secrets at deploy time.
Group Command Commands Description libSQL notploy libsql14 Provision and operate libSQL (SQLite-compatible) databases. MariaDB notploy mariadb16 Provision and operate MariaDB databases, including backups and external ports. MongoDB notploy mongo16 Provision and operate MongoDB databases, including backups and external ports. MySQL notploy mysql16 Provision and operate MySQL databases, including backups and external ports. PostgreSQL notploy postgres16 Provision and operate PostgreSQL databases, including backups and external ports. Redis notploy redis16 Provision and operate Redis instances, including backups and external ports.
Group Command Commands Description Backups notploy backup12 Scheduled and manual backups for databases, Compose services and the web server. Destinations notploy destination7 S3-compatible storage destinations that backups are uploaded to. Object storage notploy object-storage15 S3-compatible providers and buckets used as backup destinations, including usage and health. Volume backups notploy volume-backups6 Back up Docker volumes on a schedule and download the resulting archives.
Group Command Commands Description Certificates notploy certificates8 Custom TLS certificates loaded by Traefik alongside automatic Let's Encrypt ones. DNS providers notploy dns-provider15 Zones and records for connected DNS providers such as Cloudflare and Route 53. Domains notploy domain11 Attach domains to applications and Compose stacks, and generate or validate them. Forward auth notploy forward-auth10 Deploy an authentication proxy in front of applications and manage its domains. Networks notploy network10 Docker networks: create, import, inspect and resynchronise them across servers. Onion services notploy onion9 Tor onion services attached to a Compose stack: create, start, stop and inspect their status. Ports notploy port4 Publish container ports directly, without routing them through a domain. Redirects notploy redirects4 HTTP redirects served by Traefik for an application's domains.
Group Command Commands Description Bitbucket notploy bitbucket7 Bitbucket connections, plus branch and repository lookups. Git providers notploy git-provider4 List, share and remove every Git provider connected to an organization. Gitea notploy gitea8 Gitea connections, plus branch and repository lookups. GitHub notploy github6 GitHub app connections, plus branch and repository lookups. GitLab notploy gitlab7 GitLab connections, plus branch and repository lookups.
Group Command Commands Description Cluster notploy cluster4 Add and remove Swarm workers and managers. Docker notploy docker20 Containers, the Docker daemon configuration, events and container files. Docker disk usage notploy docker-disk-usage3 Disk usage per Docker object type, and build cache pruning. Docker images notploy docker-image3 List, inspect and remove images stored on a server. Docker volumes notploy docker-volume8 Inspect volumes, their size and the files inside them. Network providers notploy network-provider9 External network providers (overlay networks and peers) plus their health checks. Registries notploy registry17 Container registries used to pull private images. Servers notploy server21 Add remote servers over SSH, validate them and read their metrics and services. SSH keys notploy ssh-key7 SSH keys used to reach servers and clone private repositories. Swarm notploy swarm5 Inspect Docker Swarm nodes, node workloads and container statistics.
Group Command Commands Description Notifications notploy notification41 Notification channels — Slack, Discord, Telegram, email and others — plus test deliveries.
Group Command Commands Description Audit log notploy audit-log1 Every recorded action performed in the organization. Custom roles notploy custom-role6 Organization roles built from a set of permission statements. Organizations notploy organization11 Organizations, members, invitations and the active organization. SCIM notploy scim3 SCIM provisioning providers and tokens used for directory sync. SSO notploy sso16 Single sign-on providers, enforcement and trusted origins. Users notploy user26 Accounts, API keys, sessions, permissions and per-user metrics.
Group Command Commands Description Admin notploy admin1 Administrative operations that apply to the whole instance. Community notploy community14 Community sources, repositories, releases and the health report of the instance's community presence. Settings notploy settings57 Instance-wide settings: Traefik, Docker cleanup, monitoring, GPUs, updates and SSH. Status page notploy status12 Publish incidents and maintenance windows to the public status page. Stripe notploy stripe15 Billing for Notploy Cloud: plans, invoices, checkout and the customer portal. Whitelabeling notploy whitelabeling4 Rebrand the instance: application name, logos, favicon and links.
Group Command Commands Description AI notploy ai14 AI providers and models, plus log analysis and configuration suggestions.
Groups are the first argument and commands the second: notploy <group> <command>. Both are
lowercase and hyphenated, matching the API namespace they call (docker-disk-usage →
dockerDiskUsage.*).
Flags are the input fields of that operation, in camelCase: --environmentId is passed
through as environmentId. A flag marked Yes in the Required column aborts the command
when it is missing, so it always has to be provided; the others are omitted from the request when you
leave them out, which lets the server apply its defaults.
Flag names, required flags and allowed values are read from the CLI itself, so this page cannot drift
from what notploy --help reports.