Skip to main content

CLI reference

Run commands from the tinymash runtime root:

php8.4 bin/tinymash.php list
php8.4 bin/tinymash.php <command> --help

The help page is authoritative for arguments, options, defaults, constraints, and examples. Active plugins can add commands to the list.

General and setup

Command Purpose
list List available commands.
help Show help for a command.
completion Generate shell completion output.
setup Configure a deployed installation and create its first superadmin.
check-updates Check Composer packages for updates and security advisories.
system:status Show the current runtime status.
system:plugins Show plugin activation, manifest warnings, and boot errors.
system:themes Show theme status and manifest warnings.

Content, users, and media

Command Purpose
content:publish-due Publish scheduled content that has reached its activation time.
user:list List local users, roles, and account status.
user:set-password Create a user or replace an existing password.
media:usage Report stored media and known references.
media:cleanup Report unused media or generate missing display derivatives.
audit:remote-media Find remote image references in stored content.

Cache, maintenance, and diagnostics

Command Purpose
cache:clear Clear compiled templates and persistent runtime caches.
cache:warm Prepare content, media, and public page caches.
housekeeping:status Show housekeeping policy and last-run state.
housekeeping:run Run core and active-plugin housekeeping.
maintenance:status Show whether maintenance mode is enabled.
maintenance:on Enable maintenance mode.
maintenance:off Disable maintenance mode.
benchmark:public Measure selected public routes.

Deploy, upgrade, and transfer

Command Purpose
deploy Build a deployable runtime tree.
deploy:audit Compare deployed files with the release manifest.
upgrade:prepare Prepare a clean release with state from an older installation.
export:site Export complete site state to a portable directory.
export:author Export one author and their state.
import:site Import a site export into the current installation.
import:author Import an author bundle and set a new login password.
static-export:site Export public site and author pages as static files.
static-export:author Export one public author space as static files.

Plugin commands

Command Purpose
blogger-import Preview or import a Blogger export.
bludit-import Preview or import a local Bludit site.
wordpress-import Preview or import a WordPress WXR export.
markdown-sync Plan or push a Markdown page collection.
fediverse Run the Fediverse delivery and removal queue.
rss-reader Refresh saved RSS and Atom sources.
weather Refresh saved weather feeds.
whats-up Refresh saved iCalendar sources.

Run mutating commands as the installation owner. Root execution can create files that PHP-FPM cannot update later.