stattic-cli
v0.0.10
Published
Command-line interface for publishing and managing Stattic spaces.
Downloads
897
Readme
stattic-cli
The Stattic CLI publishes static sites, build outputs, docs, reports, and space previews from your terminal or automation. It is the fastest way to get a live Stattic URL from a local folder.
curl -fsSL https://stattic.net/install.sh | bash
stattic publish ./distThe first publish creates a live anonymous space and writes
.stattic/state.json inside the published directory. Publish the same directory
again to update the same space. stattic publish waits until the version
is live, refreshes the cache, verifies the live and immutable URLs, then prints
a version receipt.
Use the CLI interactively from a terminal, or pass --json on any command for
agent and CI workflows.
Quick Start
stattic doctor
stattic publish ./distTo publish into your account or team:
stattic login
stattic teams default my-team
stattic publish ./distFor CI, create an access token in Stattic and set STATTIC_TOKEN, or pass
--token directly:
STATTIC_TOKEN=st_... stattic publish ./dist --jsonRouting Files
When publishing a directory, the CLI uploads root _redirects and _headers
files and validates them before finalizing the version. _redirects supports
redirects, rewrites, custom 404 rules, and proxy rules. _headers supports
validated response headers and Basic-Auth.
Proxy rules use absolute external 200 destinations in _redirects:
/api/* https://api.example.com/:splat 200Internal 200 destinations are rewrites.
Documentation
Tab completion
$ stattic autocomplete bash # or zsh / fish / powershell
$ stattic autocomplete --refresh-cacheFollow the printed instructions to add the completion script to your shell init file.
Working directory
$ stattic --cwd ./apps/docs deploy
$ stattic --cwd=/tmp/site env lsPass --cwd <path> to any command to operate as if it ran from that directory.
Useful in monorepos, CI scripts, or when the project state lives elsewhere.
Usage
$ curl -fsSL https://stattic.net/install.sh | bash
$ stattic COMMAND
running command...
$ stattic (--version)
stattic-cli/0.0.9 darwin-arm64
$ stattic --help [COMMAND]
USAGE
$ stattic COMMAND
...Commands
stattic analyticsstattic autocomplete [SHELL]stattic backupsstattic backups add [TYPE]stattic backups download BACKUPstattic backups get BACKUPstattic backups lsstattic backups rm BACKUPstattic cachestattic cache purgestattic certsstattic certs activate CERTIFICATEstattic certs addstattic certs deactivate CERTIFICATEstattic certs get [CERTIFICATE]stattic certs lsstattic certs retrystattic certs rm CERTIFICATEstattic certs settingsstattic certs settings android-compatstattic certs settings getstattic certs settings hsts-preload disablestattic certs settings hsts-subdomainstattic certs settings social-crawler-redirectstattic certs update CERTIFICATEstattic certs validatestattic cronsstattic crons addstattic crons lsstattic crons rm CRONstattic crons update CRONstattic dbstattic db phpmyadminstattic db reset-passwordstattic deploy [DIR]stattic doctorstattic domainsstattic domains add HOSTNAMEstattic domains check DOMAINstattic domains diagnostics DOMAINstattic domains lsstattic domains rm DOMAINstattic envstattic env lsstattic env pullstattic env rm NAMEstattic env set NAME VALUEstattic firewallstattic firewall addstattic firewall lsstattic firewall rm RULEstattic help [COMMAND]stattic initstattic inspect TARGETstattic keysstattic keys add NAMEstattic keys get NAMEstattic keys lsstattic keys rm NAMEstattic linkstattic loginstattic logoutstattic logs [TARGET] [KIND]stattic open [TARGET]stattic password clearstattic password setstattic promote VERSIONstattic provider OPERATIONstattic publish [DIR]stattic rollback VERSIONstattic routingstattic routing computestattic routing inspectstattic settingsstattic settings access-typestattic settings edge-cachestattic settings persistent-datastattic settings site-metastattic settings site-optionsstattic settings ssh-migrationstattic sftpstattic sftp add USERNAMEstattic sftp disconnectstattic sftp get USERNAMEstattic sftp lsstattic sftp rm USERNAMEstattic sftp sync [DIR]stattic sftp sync pull [DIR]stattic sftp sync push [DIR]stattic sftp sync status [DIR]stattic sftp update USERNAMEstattic spacesstattic spaces addstattic spaces claimstattic spaces downloadstattic spaces duplicatestattic spaces getstattic spaces lsstattic spaces rmstattic spaces updatestattic statusstattic switch [TEAM]stattic teamsstattic teams invitationsstattic teams invitations add EMAILstattic teams invitations cancel INVITATIONstattic teams invitations lsstattic teams invitations resend INVITATIONstattic teams lsstattic teams membersstattic teams members lsstattic teams members rm MEMBERstattic teams switch [TEAM]stattic versionsstattic versions lsstattic whoamistattic wpstattic wp softwarestattic wp version VERSION
stattic analytics
Print runtime analytics.
USAGE
$ stattic analytics [--json] [--api-url <value>] [--token <value>] [-y] [--claim-token <value>] [-o <value>]
[--space <value>] [--range 24h|7d|30d]
FLAGS
--range=<option> [default: 24h] Analytics range.
<options: 24h|7d|30d>
SPACE SELECTION FLAGS
-o, --team=<value> [env: STATTIC_TEAM] Team slug, ID, or name.
--space=<value> [env: STATTIC_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
AUTHENTICATION FLAGS
--claim-token=<value> [env: STATTIC_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Print runtime analytics.
Print runtime analytics series.stattic autocomplete [SHELL]
Display autocomplete installation instructions.
USAGE
$ stattic autocomplete [SHELL] [-r]
ARGUMENTS
[SHELL] (zsh|bash|powershell) Shell type
FLAGS
-r, --refresh-cache Refresh cache (ignores displaying instructions)
DESCRIPTION
Display autocomplete installation instructions.
EXAMPLES
$ stattic autocomplete
$ stattic autocomplete bash
$ stattic autocomplete zsh
$ stattic autocomplete powershell
$ stattic autocomplete --refresh-cacheSee code: @oclif/plugin-autocomplete
stattic backups
Manage backups.
USAGE
$ stattic backups [--json] [--api-url <value>] [--token <value>] [-y]
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Manage backups.
Manage backups for a PHP or WordPress space.stattic backups add [TYPE]
Create a backup.
USAGE
$ stattic backups add [TYPE] [--json] [--api-url <value>] [--token <value>] [-y] [--claim-token <value>] [-o
<value>] [--space <value>]
ARGUMENTS
[TYPE] Backup type: fs or db. Defaults to fs.
SPACE SELECTION FLAGS
-o, --team=<value> [env: STATTIC_TEAM] Team slug, ID, or name.
--space=<value> [env: STATTIC_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
AUTHENTICATION FLAGS
--claim-token=<value> [env: STATTIC_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Create a backup.
Request an on-demand backup for a PHP or WordPress space.stattic backups download BACKUP
Download a backup.
USAGE
$ stattic backups download BACKUP [--json] [--api-url <value>] [--token <value>] [-y] [--claim-token <value>] [-o
<value>] [--space <value>] [-f <value>]
ARGUMENTS
BACKUP Backup ID to download.
FLAGS
-f, --output=<value> Output file path.
SPACE SELECTION FLAGS
-o, --team=<value> [env: STATTIC_TEAM] Team slug, ID, or name.
--space=<value> [env: STATTIC_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
AUTHENTICATION FLAGS
--claim-token=<value> [env: STATTIC_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Download a backup.
Download a backup archive.stattic backups get BACKUP
Show backup details.
USAGE
$ stattic backups get BACKUP [--json] [--api-url <value>] [--token <value>] [-y] [--claim-token <value>] [-o
<value>] [--space <value>]
ARGUMENTS
BACKUP Backup ID to inspect.
SPACE SELECTION FLAGS
-o, --team=<value> [env: STATTIC_TEAM] Team slug, ID, or name.
--space=<value> [env: STATTIC_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
AUTHENTICATION FLAGS
--claim-token=<value> [env: STATTIC_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Show backup details.
Show backup details and download path.stattic backups ls
List backups.
USAGE
$ stattic backups ls [--json] [--api-url <value>] [--token <value>] [-y] [--claim-token <value>] [-o <value>]
[--space <value>]
SPACE SELECTION FLAGS
-o, --team=<value> [env: STATTIC_TEAM] Team slug, ID, or name.
--space=<value> [env: STATTIC_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
AUTHENTICATION FLAGS
--claim-token=<value> [env: STATTIC_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List backups.
List backups for a PHP or WordPress space.stattic backups rm BACKUP
Delete an on-demand backup.
USAGE
$ stattic backups rm BACKUP [--json] [--api-url <value>] [--token <value>] [-y] [--claim-token <value>] [-o
<value>] [--space <value>]
ARGUMENTS
BACKUP Backup ID to delete.
SPACE SELECTION FLAGS
-o, --team=<value> [env: STATTIC_TEAM] Team slug, ID, or name.
--space=<value> [env: STATTIC_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
AUTHENTICATION FLAGS
--claim-token=<value> [env: STATTIC_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Delete an on-demand backup.
Request deletion for an on-demand backup.stattic cache
Manage cache.
USAGE
$ stattic cache [--json] [--api-url <value>] [--token <value>] [-y]
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Manage cache.
Inspect and purge runtime cache for a space.stattic cache purge
Purge runtime cache.
USAGE
$ stattic cache purge [--json] [--api-url <value>] [--token <value>] [-y] [--claim-token <value>] [-o <value>]
[--space <value>] [--action invalidate|delete] [--target space|domain|path] [--value <value>]
FLAGS
--action=<option> [default: invalidate] Cache purge action.
<options: invalidate|delete>
--target=<option> [default: space] Cache purge target.
<options: space|domain|path>
--value=<value> Domain hostname or path when target requires a value.
SPACE SELECTION FLAGS
-o, --team=<value> [env: STATTIC_TEAM] Team slug, ID, or name.
--space=<value> [env: STATTIC_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
AUTHENTICATION FLAGS
--claim-token=<value> [env: STATTIC_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Purge runtime cache.
Queue a runtime cache purge.stattic certs
Manage certs.
USAGE
$ stattic certs [--json] [--api-url <value>] [--token <value>] [-y]
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Manage certs.
Manage custom certificates and SSL settings for a PHP or WordPress space.stattic certs activate CERTIFICATE
Activate a custom certificate.
USAGE
$ stattic certs activate CERTIFICATE [--json] [--api-url <value>] [--token <value>] [-y] [--claim-token <value>]
[-o <value>] [--space <value>] [--domains <value>]
ARGUMENTS
CERTIFICATE Certificate ID to activate.
SPACE SELECTION FLAGS
-o, --team=<value> [env: STATTIC_TEAM] Team slug, ID, or name.
--space=<value> [env: STATTIC_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
AUTHENTICATION FLAGS
--claim-token=<value> [env: STATTIC_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
CERTIFICATE FLAGS
--domains=<value> Comma-separated domains to activate the certificate for.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Activate a custom certificate.
Activate a staged custom certificate.stattic certs add
Stage a custom certificate.
USAGE
$ stattic certs add [--json] [--api-url <value>] [--token <value>] [-y] [--claim-token <value>] [-o <value>]
[--space <value>] [--domains <value>] [--certificate <value>] [--certificate-file <value>] [--private-key <value>]
[--private-key-file <value>] [--csr <value>] [--csr-file <value>] [--trusted-certificates <value>]
[--trusted-certificates-file <value>] [--client-certificate <value>] [--client-certificate-file <value>]
SPACE SELECTION FLAGS
-o, --team=<value> [env: STATTIC_TEAM] Team slug, ID, or name.
--space=<value> [env: STATTIC_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
CERTIFICATE FLAGS
--certificate=<value> PEM certificate or chain.
--certificate-file=<value> Path to a PEM certificate or chain file.
--client-certificate=<value> PEM client certificate for mTLS.
--client-certificate-file=<value> Path to a PEM client certificate file.
--csr=<value> PEM certificate signing request.
--csr-file=<value> Path to a PEM certificate signing request file.
--domains=<value> Comma-separated domains for the certificate.
--private-key=<value> PEM private key.
--private-key-file=<value> Path to a PEM private key file.
--trusted-certificates=<value> PEM trusted CA certificates.
--trusted-certificates-file=<value> Path to a PEM trusted CA certificates file.
AUTHENTICATION FLAGS
--claim-token=<value> [env: STATTIC_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Stage a custom certificate.
Stage a custom certificate.stattic certs deactivate CERTIFICATE
Deactivate a custom certificate.
USAGE
$ stattic certs deactivate CERTIFICATE [--json] [--api-url <value>] [--token <value>] [-y] [--claim-token <value>]
[-o <value>] [--space <value>]
ARGUMENTS
CERTIFICATE Certificate ID to deactivate.
SPACE SELECTION FLAGS
-o, --team=<value> [env: STATTIC_TEAM] Team slug, ID, or name.
--space=<value> [env: STATTIC_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
AUTHENTICATION FLAGS
--claim-token=<value> [env: STATTIC_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Deactivate a custom certificate.
Deactivate a custom certificate.stattic certs get [CERTIFICATE]
Show custom certificate details.
USAGE
$ stattic certs get [CERTIFICATE] [--json] [--api-url <value>] [--token <value>] [-y] [--claim-token <value>]
[-o <value>] [--space <value>]
ARGUMENTS
[CERTIFICATE] Certificate ID. Omit to show the active certificate.
SPACE SELECTION FLAGS
-o, --team=<value> [env: STATTIC_TEAM] Team slug, ID, or name.
--space=<value> [env: STATTIC_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
AUTHENTICATION FLAGS
--claim-token=<value> [env: STATTIC_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Show custom certificate details.
Show custom certificate details.stattic certs ls
List custom certificates.
USAGE
$ stattic certs ls [--json] [--api-url <value>] [--token <value>] [-y] [--claim-token <value>] [-o <value>]
[--space <value>]
SPACE SELECTION FLAGS
-o, --team=<value> [env: STATTIC_TEAM] Team slug, ID, or name.
--space=<value> [env: STATTIC_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
AUTHENTICATION FLAGS
--claim-token=<value> [env: STATTIC_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List custom certificates.
List custom certificates for a PHP or WordPress space.stattic certs retry
Retry SSL issuance.
USAGE
$ stattic certs retry --domain <value> [--json] [--api-url <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>]
SPACE SELECTION FLAGS
-o, --team=<value> [env: STATTIC_TEAM] Team slug, ID, or name.
--space=<value> [env: STATTIC_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
AUTHENTICATION FLAGS
--claim-token=<value> [env: STATTIC_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
SSL FLAGS
--domain=<value> (required) Domain name.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Retry SSL issuance.
Retry SSL issuance for a domain.stattic certs rm CERTIFICATE
Delete a custom certificate.
USAGE
$ stattic certs rm CERTIFICATE [--json] [--api-url <value>] [--token <value>] [-y] [--claim-token <value>]
[-o <value>] [--space <value>]
ARGUMENTS
CERTIFICATE Certificate ID to delete.
SPACE SELECTION FLAGS
-o, --team=<value> [env: STATTIC_TEAM] Team slug, ID, or name.
--space=<value> [env: STATTIC_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
AUTHENTICATION FLAGS
--claim-token=<value> [env: STATTIC_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Delete a custom certificate.
Delete an inactive custom certificate.stattic certs settings
Manage SSL settings.
USAGE
$ stattic certs settings [--json] [--api-url <value>] [--token <value>] [-y]
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Manage SSL settings.
Manage SSL settings for a PHP or WordPress space domain.stattic certs settings android-compat
Update Android compatibility.
USAGE
$ stattic certs settings android-compat --domain <value> [--json] [--api-url <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [--enabled]
SPACE SELECTION FLAGS
-o, --team=<value> [env: STATTIC_TEAM] Team slug, ID, or name.
--space=<value> [env: STATTIC_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
AUTHENTICATION FLAGS
--claim-token=<value> [env: STATTIC_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
SSL FLAGS
--domain=<value> (required) Domain name.
--[no-]enabled Enable the setting. Use --no-enabled to disable.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Update Android compatibility.
Enable or disable SSL Android compatibility.stattic certs settings get
Show SSL information.
USAGE
$ stattic certs settings get --domain <value> [--json] [--api-url <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>]
SPACE SELECTION FLAGS
-o, --team=<value> [env: STATTIC_TEAM] Team slug, ID, or name.
--space=<value> [env: STATTIC_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
AUTHENTICATION FLAGS
--claim-token=<value> [env: STATTIC_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
SSL FLAGS
--domain=<value> (required) Domain name.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Show SSL information.
Show SSL information for a domain.stattic certs settings hsts-preload disable
Disable HSTS preload.
USAGE
$ stattic certs settings hsts-preload disable --domain <value> [--json] [--api-url <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>]
SPACE SELECTION FLAGS
-o, --team=<value> [env: STATTIC_TEAM] Team slug, ID, or name.
--space=<value> [env: STATTIC_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
AUTHENTICATION FLAGS
--claim-token=<value> [env: STATTIC_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
SSL FLAGS
--domain=<value> (required) Domain name.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Disable HSTS preload.
Disable HSTS preload for a domain.stattic certs settings hsts-subdomain
Update HSTS includeSubDomains.
USAGE
$ stattic certs settings hsts-subdomain --domain <value> [--json] [--api-url <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [--enabled]
SPACE SELECTION FLAGS
-o, --team=<value> [env: STATTIC_TEAM] Team slug, ID, or name.
--space=<value> [env: STATTIC_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
AUTHENTICATION FLAGS
--claim-token=<value> [env: STATTIC_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
SSL FLAGS
--domain=<value> (required) Domain name.
--[no-]enabled Enable the setting. Use --no-enabled to disable.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Update HSTS includeSubDomains.
Enable or disable HSTS includeSubDomains for a domain.stattic certs settings social-crawler-redirect
Update social crawler redirects.
USAGE
$ stattic certs settings social-crawler-redirect --domain <value> [--json] [--api-url <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [--enabled]
SPACE SELECTION FLAGS
-o, --team=<value> [env: STATTIC_TEAM] Team slug, ID, or name.
--space=<value> [env: STATTIC_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
AUTHENTICATION FLAGS
--claim-token=<value> [env: STATTIC_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
SSL FLAGS
--domain=<value> (required) Domain name.
--[no-]enabled Enable the setting. Use --no-enabled to disable.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Update social crawler redirects.
Enable or disable social crawler redirects.stattic certs update CERTIFICATE
Update a custom certificate.
USAGE
$ stattic certs update CERTIFICATE [--json] [--api-url <value>] [--token <value>] [-y] [--claim-token <value>]
[-o <value>] [--space <value>] [--domains <value>] [--certificate <value>] [--certificate-file <value>]
[--private-key <value>] [--private-key-file <value>] [--csr <value>] [--csr-file <value>] [--trusted-certificates
<value>] [--trusted-certificates-file <value>] [--client-certificate <value>] [--client-certificate-file <value>]
ARGUMENTS
CERTIFICATE Certificate ID to update.
SPACE SELECTION FLAGS
-o, --team=<value> [env: STATTIC_TEAM] Team slug, ID, or name.
--space=<value> [env: STATTIC_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
CERTIFICATE FLAGS
--certificate=<value> PEM certificate or chain.
--certificate-file=<value> Path to a PEM certificate or chain file.
--client-certificate=<value> PEM client certificate for mTLS.
--client-certificate-file=<value> Path to a PEM client certificate file.
--csr=<value> PEM certificate signing request.
--csr-file=<value> Path to a PEM certificate signing request file.
--domains=<value> Comma-separated domains for the certificate.
--private-key=<value> PEM private key.
--private-key-file=<value> Path to a PEM private key file.
--trusted-certificates=<value> PEM trusted CA certificates.
--trusted-certificates-file=<value> Path to a PEM trusted CA certificates file.
AUTHENTICATION FLAGS
--claim-token=<value> [env: STATTIC_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Update a custom certificate.
Update a custom certificate.stattic certs validate
Validate a custom certificate.
USAGE
$ stattic certs validate [--json] [--api-url <value>] [--token <value>] [-y] [--claim-token <value>] [-o <value>]
[--space <value>] [--domains <value>] [--certificate <value>] [--certificate-file <value>] [--private-key <value>]
[--private-key-file <value>] [--csr <value>] [--csr-file <value>] [--trusted-certificates <value>]
[--trusted-certificates-file <value>] [--client-certificate <value>] [--client-certificate-file <value>]
SPACE SELECTION FLAGS
-o, --team=<value> [env: STATTIC_TEAM] Team slug, ID, or name.
--space=<value> [env: STATTIC_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
CERTIFICATE FLAGS
--certificate=<value> PEM certificate or chain.
--certificate-file=<value> Path to a PEM certificate or chain file.
--client-certificate=<value> PEM client certificate for mTLS.
--client-certificate-file=<value> Path to a PEM client certificate file.
--csr=<value> PEM certificate signing request.
--csr-file=<value> Path to a PEM certificate signing request file.
--domains=<value> Comma-separated domains for the certificate.
--private-key=<value> PEM private key.
--private-key-file=<value> Path to a PEM private key file.
--trusted-certificates=<value> PEM trusted CA certificates.
--trusted-certificates-file=<value> Path to a PEM trusted CA certificates file.
AUTHENTICATION FLAGS
--claim-token=<value> [env: STATTIC_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Validate a custom certificate.
Validate a custom certificate without staging it.stattic crons
Manage cron entries.
USAGE
$ stattic crons [--json] [--api-url <value>] [--token <value>] [-y]
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Manage cron entries.
Manage cron entries for a PHP or WordPress space.stattic crons add
Create a cron entry.
USAGE
$ stattic crons add --schedule <value> --command <value> [--json] [--api-url <value>] [--token <value>] [-y]
[--claim-token <value>] [-o <value>] [--space <value>]
SPACE SELECTION FLAGS
-o, --team=<value> [env: STATTIC_TEAM] Team slug, ID, or name.
--space=<value> [env: STATTIC_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
AUTHENTICATION FLAGS
--claim-token=<value> [env: STATTIC_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
CRON FLAGS
--command=<value> (required) Command to run.
--schedule=<value> (required) Cron schedule.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Create a cron entry.
Create a cron entry. Schedules support hourly, daily, twicedaily, weekly, shorthand like 2h, or full crontab
expressions.stattic crons ls
List cron entries.
USAGE
$ stattic crons ls [--json] [--api-url <value>] [--token <value>] [-y] [--claim-token <value>] [-o <value>]
[--space <value>]
SPACE SELECTION FLAGS
-o, --team=<value> [env: STATTIC_TEAM] Team slug, ID, or name.
--space=<value> [env: STATTIC_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
AUTHENTICATION FLAGS
--claim-token=<value> [env: STATTIC_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List cron entries.
List cron entries for a PHP or WordPress space.stattic crons rm CRON
Remove a cron entry.
USAGE
$ stattic crons rm CRON [--json] [--api-url <value>] [--token <value>] [-y] [--claim-token <value>] [-o
<value>] [--space <value>]
ARGUMENTS
CRON Cron ID to remove.
SPACE SELECTION FLAGS
-o, --team=<value> [env: STATTIC_TEAM] Team slug, ID, or name.
--space=<value> [env: STATTIC_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
AUTHENTICATION FLAGS
--claim-token=<value> [env: STATTIC_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Remove a cron entry.
Remove a cron entry.stattic crons update CRON
Update a cron entry.
USAGE
$ stattic crons update CRON --command <value> [--json] [--api-url <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>]
ARGUMENTS
CRON Cron ID to update.
SPACE SELECTION FLAGS
-o, --team=<value> [env: STATTIC_TEAM] Team slug, ID, or name.
--space=<value> [env: STATTIC_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
AUTHENTICATION FLAGS
--claim-token=<value> [env: STATTIC_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
CRON FLAGS
--command=<value> (required) New command to run.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Update a cron entry.
Update the command for a cron entry.stattic db
Manage database.
USAGE
$ stattic db [--json] [--api-url <value>] [--token <value>] [-y]
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Manage database.
Manage PHP or WordPress space database access.stattic db phpmyadmin
Open phpMyAdmin access.
USAGE
$ stattic db phpmyadmin [--json] [--api-url <value>] [--token <value>] [-y] [--claim-token <value>] [-o <value>]
[--space <value>]
SPACE SELECTION FLAGS
-o, --team=<value> [env: STATTIC_TEAM] Team slug, ID, or name.
--space=<value> [env: STATTIC_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
AUTHENTICATION FLAGS
--claim-token=<value> [env: STATTIC_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Open phpMyAdmin access.
Create a temporary phpMyAdmin URL for a PHP or WordPress space.stattic db reset-password
Reset the database password.
USAGE
$ stattic db reset-password [--json] [--api-url <value>] [--token <value>] [-y] [--claim-token <value>] [-o <value>]
[--space <value>]
SPACE SELECTION FLAGS
-o, --team=<value> [env: STATTIC_TEAM] Team slug, ID, or name.
--space=<value> [env: STATTIC_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
AUTHENTICATION FLAGS
--claim-token=<value> [env: STATTIC_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Reset the database password.
Request a database password reset for a PHP or WordPress space.stattic deploy [DIR]
Build and deploy to Stattic.
USAGE
$ stattic deploy [DIR] [--json] [--api-url <value>] [--token <value>] [-y] [--claim-token <value>] [-o
<value>] [--space <value>] [-n <value>] [--spa auto|true|false] [--git-branch <value>] [--git-commit <value>]
[--git-ref <value>] [--git-repository <value>] [--source-type direct-upload|git] [--dry-run] [--wait]
[--wait-timeout <value>] [--root-directory <value>] [--install-command <value>] [--build-command <value>]
[--output-directory <value>] [--skip-install] [--skip-build] [--allow-unsupported-platform-features]
ARGUMENTS
[DIR] Repository directory to build and deploy. Defaults to the current directory.
SPACE METADATA FLAGS
-n, --name=<value> Set the space title.
--spa=<option> [default: auto] Control single-page app fallback detection.
<options: auto|true|false>
SPACE SELECTION FLAGS
-o, --team=<value> [env: STATTIC_TEAM] Team slug, ID, or name.
--space=<value> [env: STATTIC_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
MIGRATION FLAGS
--allow-unsupported-platform-features Deploy even when imported platform config includes features Stattic cannot
convert.
BUILD FLAGS
--build-command=<value> Build command. Defaults to framework and package script detection.
--install-command=<value> Install command. Defaults to package-manager detection.
--output-directory=<value> Build output directory relative to the app root.
--root-directory=<value> Repository subdirectory that contains the app.
--skip-build Skip the build command and publish the output directory as-is.
--skip-install Skip the install command.
AUTHENTICATION FLAGS
--claim-token=<value> [env: STATTIC_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
EXECUTION FLAGS
--dry-run Print the detected build plan without installing, building, or publishing.
--[no-]wait Wait until queued publish work finishes before returning.
--wait-timeout=<value> [default: 900] Seconds to wait for the version to become ready.
VERSION SOURCE FLAGS
--git-branch=<value> [env: STATTIC_GIT_BRANCH] Git branch name to record on the version.
--git-commit=<value> [env: STATTIC_GIT_COMMIT] Git commit SHA to record on the version.
--git-ref=<value> [env: STATTIC_GIT_REF] Git ref to record on the version.
--git-repository=<value> [env: STATTIC_GIT_REPOSITORY] Git repository to record on the version, for example
owner/repo.
--source-type=<option> [env: STATTIC_SOURCE_TYPE] Version source type to record.
<options: direct-upload|git>
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Build and deploy to Stattic.
Detect build settings, run the build, and publish the output directory to Stattic.
EXAMPLES
Build the current repository and publish it.
$ stattic deploy
Build a monorepo app and publish its output.
$ stattic deploy --root-directory apps/web --output-directory diststattic doctor
Diagnose Stattic CLI setup.
USAGE
$ stattic doctor [--json] [--api-url <value>] [--token <value>] [-y] [--claim-token <value>] [-o <value>]
[--space <value>]
SPACE SELECTION FLAGS
-o, --team=<value> [env: STATTIC_TEAM] Team slug, ID, or name.
--space=<value> [env: STATTIC_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
AUTHENTICATION FLAGS
--claim-token=<value> [env: STATTIC_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Diagnose Stattic CLI setup.
Check local CLI state, auth, API reachability, and space selection for the current directory.stattic domains
Manage domains.
USAGE
$ stattic domains [--json] [--api-url <value>] [--token <value>] [-y]
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Manage domains.
Manage space domains.stattic domains add HOSTNAME
Attach a domain.
USAGE
$ stattic domains add HOSTNAME [--json] [--api-url <value>] [--token <value>] [-y] [--claim-token <value>] [-o
<value>] [--space <value>] [--wait] [--redirect-to <value> --role standard|redirect]
ARGUMENTS
HOSTNAME Hostname to attach.
SPACE SELECTION FLAGS
-o, --team=<value> [env: STATTIC_TEAM] Team slug, ID, or name.
--space=<value> [env: STATTIC_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
AUTHENTICATION FLAGS
--claim-token=<value> [env: STATTIC_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DOMAIN BEHAVIOR FLAGS
--redirect-to=<value> Destination for redirect domains.
--role=<option> How the domain should behave.
<options: standard|redirect>
EXECUTION FLAGS
--[no-]wait Wait until queued work finishes before returning.
DESCRIPTION
Attach a domain.
Create a domain in the space team, attach it to the space, and queue a DNS check.stattic domains check DOMAIN
Check a domain.
USAGE
$ stattic domains check DOMAIN [--json] [--api-url <value>] [--token <value>] [-y] [--claim-token <value>] [-o
<value>] [--space <value>] [--wait]
ARGUMENTS
DOMAIN Domain ID or hostname.
SPACE SELECTION FLAGS
-o, --team=<value> [env: STATTIC_TEAM] Team slug, ID, or name.
--space=<value> [env: STATTIC_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
AUTHENTICATION FLAGS
--claim-token=<value> [env: STATTIC_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
EXECUTION FLAGS
--[no-]wait Wait until queued work finishes before returning.
DESCRIPTION
Check a domain.
Queue a DNS/provider readiness check for an attached domain.stattic domains diagnostics DOMAIN
Inspect domain diagnostics.
USAGE
$ stattic domains diagnostics DOMAIN [--json] [--api-url <value>] [--token <value>] [-y] [--claim-token <value>] [-o
<value>] [--space <value>]
ARGUMENTS
DOMAIN Domain ID or hostname.
SPACE SELECTION FLAGS
-o, --team=<value> [env: STATTIC_TEAM] Team slug, ID, or name.
--space=<value> [env: STATTIC_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
AUTHENTICATION FLAGS
--claim-token=<value> [env: STATTIC_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Inspect domain diagnostics.
Read live DNS and SSL diagnostics for an attached domain.stattic domains ls
List space domains.
USAGE
$ stattic domains ls [--json] [--api-url <value>] [--token <value>] [-y] [--claim-token <value>] [-o <value>]
[--space <value>]
SPACE SELECTION FLAGS
-o, --team=<value> [env: STATTIC_TEAM] Team slug, ID, or name.
--space=<value> [env: STATTIC_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
AUTHENTICATION FLAGS
--claim-token=<value> [env: STATTIC_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List space domains.
List domains attached to a space.stattic domains rm DOMAIN
Remove a domain.
USAGE
$ stattic domains rm DOMAIN [--json] [--api-url <value>] [--token <value>] [-y] [--claim-token <value>] [-o
<value>] [--space <value>] [--wait]
ARGUMENTS
DOMAIN Domain ID or hostname.
SPACE SELECTION FLAGS
-o, --team=<value> [env: STATTIC_TEAM] Team slug, ID, or name.
--space=<value> [env: STATTIC_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
AUTHENTICATION FLAGS
--claim-token=<value> [env: STATTIC_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
EXECUTION FLAGS
--[no-]wait Wait until queued publish work finishes before returning.
DESCRIPTION
Remove a domain.
Remove a domain assignment from a space.stattic env
Manage env vars.
USAGE
$ stattic env [--json] [--api-url <value>] [--token <value>] [-y]
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Manage env vars.
Manage space environment variables.stattic env ls
List space variables.
USAGE
$ stattic env ls [--json] [--api-url <value>] [--token <value>] [-y] [--claim-token <value>] [-o <value>]
[--space <value>] [--show-values]
FLAGS
--show-values Print plaintext variable values.
SPACE SELECTION FLAGS
-o, --team=<value> [env: STATTIC_TEAM] Team slug, ID, or name.
--space=<value> [env: STATTIC_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
AUTHENTICATION FLAGS
--claim-token=<value> [env: STATTIC_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List space variables.
List space variables.stattic env pull
Pull variables.
USAGE
$ stattic env pull [--json] [--api-url <value>] [--token <value>] [-y] [--claim-token <value>] [-o <value>]
[--space <value>] [--format env|json]
FLAGS
--format=<option> [default: env] Output format.
<options: env|json>
SPACE SELECTION FLAGS
-o, --team=<value> [env: STATTIC_TEAM] Team slug, ID, or name.
--space=<value> [env: STATTIC_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
AUTHENTICATION FLAGS
--claim-token=<value> [env: STATTIC_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Pull variables.
Pull effective space and shared variables.stattic env rm NAME
Delete a space variable.
USAGE
$ stattic env rm NAME [--json] [--api-url <value>] [--token <value>] [-y] [--claim-token <value>] [-o
<value>] [--space <value>]
ARGUMENTS
NAME Variable name.
SPACE SELECTION FLAGS
-o, --team=<value> [env: STATTIC_TEAM] Team slug, ID, or name.
--space=<value> [env: STATTIC_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
AUTHENTICATION FLAGS
--claim-token=<value> [env: STATTIC_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Delete a space variable.
Delete a space variable.stattic env set NAME VALUE
Set a space variable.
USAGE
$ stattic env set NAME VALUE [--json] [--api-url <value>] [--token <value>] [-y] [--claim-token <value>]
[-o <value>] [--space <value>]
ARGUMENTS
NAME Variable name.
VALUE Variable value.
SPACE SELECTION FLAGS
-o, --team=<value> [env: STATTIC_TEAM] Team slug, ID, or name.
--space=<value> [env: STATTIC_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
AUTHENTICATION FLAGS
--claim-token=<value> [env: STATTIC_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Set a space variable.
Create or update a space variable. Values are sent to the API and are not printed back.stattic firewall
Manage firewall rules.
USAGE
$ stattic firewall [--json] [--api-url <value>] [--token <value>] [-y]
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Manage firewall rules.
Manage egress firewall rules for a PHP or WordPress space.stattic firewall add
Create a firewall rule.
USAGE
$ stattic firewall add --port <value> --destination <value> [--json] [--api-url <value>] [--token <value>] [-y]
[--claim-token <value>] [-o <value>] [--space <value>] [--action allow|deny] [--protocol tcp|udp]
SPACE SELECTION FLAGS
-o, --team=<value> [env: STATTIC_TEAM] Team slug, ID, or name.
--space=<value> [env: STATTIC_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
FIREWALL FLAGS
--action=<option> [default: allow] Firewall action.
<options: allow|deny>
--destination=<value> (required) Destination IP address or CIDR range.
--port=<value> (required) Destination port.
--protocol=<option> [default: tcp] Protocol.
<options: tcp|udp>
AUTHENTICATION FLAGS
--claim-token=<value> [env: STATTIC_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Create a firewall rule.
Create an egress firewall rule for a PHP or WordPress space.stattic firewall ls
List firewall rules.
USAGE
$ stattic firewall ls [--json] [--api-url <value>] [--token <value>] [-y] [--claim-token <value>] [-o <value>]
[--space <value>]
SPACE SELECTION FLAGS
-o, --team=<value> [env: STATTIC_TEAM] Team slug, ID, or name.
--space=<value> [env: STATTIC_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
AUTHENTICATION FLAGS
--claim-token=<value> [env: STATTIC_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List firewall rules.
List egress firewall rules for a PHP or WordPress space.stattic firewall rm RULE
Remove a firewall rule.
USAGE
$ stattic firewall rm RULE [--json] [--api-url <value>] [--token <value>] [-y] [--claim-token <value>] [-o
<value>] [--space <value>]
ARGUMENTS
RULE Firewall rule ID to remove.
SPACE SELECTION FLAGS
-o, --team=<value> [env: STATTIC_TEAM] Team slug, ID, or name.
--space=<value> [env: STATTIC_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
AUTHENTICATION FLAGS
--claim-token=<value> [env: STATTIC_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Remove a firewall rule.
Remove a firewall rule.stattic help [COMMAND]
Display help for stattic.
USAGE
$ stattic help [COMMAND...] [-n]
ARGUMENTS
[COMMAND...] Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for stattic.See code: @oclif/plugin-help
stattic init
Create .stattic config files.
USAGE
$ stattic init [--json] [--api-url <value>] [--token <value>] [-y] [--claim-token <value>] [-o <value>]
[--space <value>] [-f] [--mode website|files] [--spa auto|true|false] [--title <value>]
EXECUTION FLAGS
-f, --force Overwrite existing .stattic/config.json.
SPACE SELECTION FLAGS
-o, --team=<value> [env: STATTIC_TEAM] Team slug, ID, or name.
--space=<value> [env: STATTIC_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
AUTHENTICATION FLAGS
--claim-token=<value> [env: STATTIC_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
SPACE METADATA FLAGS
--mode=<option> [default: website] Default space mode.
<options: website|files>
--spa=<option> [default: auto] Default SPA fallback behavior.
<options: auto|true|false>
--title=<value> Default space title.
DESCRIPTION
Create .stattic config files.
Create .stattic/config.json for a space. Pass --space to also bind this directory to a remote space (writes
.stattic/state.json).
EXAMPLES
Write a default .stattic/config.json in the current directory.
$ stattic init
Initialize config and link the current directory to space `docs`.
$ stattic init --space docsstattic inspect TARGET
Inspect a space by ID, slug, URL, or domain.
USAGE
$ stattic inspect TARGET [--json] [--api-url <value>] [--token <value>] [-y] [-o <value>]
ARGUMENTS
TARGET Space ID, slug, live URL, or domain.
SPACE SELECTION FLAGS
-o, --team=<value> [env: STATTIC_TEAM] Team slug, ID, or name.
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Inspect a space by ID, slug, URL, or domain.
Look up a space by ID, slug, live URL, or attached domain. Prints space details, live version, and runtime state.
EXAMPLES
Inspect by slug.
$ stattic inspect docs
Inspect by live URL.
$ stattic inspect https://docs.stattic.net
Inspect by ID in a specific team.
$ stattic inspect prj_abc123 --team acmestattic keys
Manage public keys.
USAGE
$ stattic keys [--json] [--api-url <value>] [--token <value>] [-y]
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Manage public keys.
Manage reusable public keys for PHP or WordPress spaces.stattic keys add NAME
Create or update a reusable public key.
USAGE
$ stattic keys add NAME --public-key <value> [--json] [--api-url <value>] [--token <value>] [-y]
[--claim-token <value>] [-o <value>] [--space <value>] [--category <value>]
ARGUMENTS
NAME Public key name.
SPACE SELECTION FLAGS
-o, --team=<value> [env: STATTIC_TEAM] Team slug, ID, or name.
--space=<value> [env: STATTIC_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: STATTIC_YES] Skip confirmation prompts.
--api-url=<value> [default: https://api.stattic.net, env: STATTIC_API_URL] Stattic API base URL.
PUBLIC KEYS FLAGS
--category=<value> [default: sftp] alias public-key category.
--public-key=<value> (required) SSH public key in authorized_keys format.
AUTHENTICATION FLAGS
--claim-token=<value> [env: STATTIC_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: STATTIC_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Create or 