golem15/summercms
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(console): show the application binary run bare and with --help

Browse Source
This commit is contained in:
Jakub Zych
2026-10-19 00:15:28 +02:00
parent 59f57819cc
commit 86c5a80496
1 changed files with 37 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
docs/console/introduction.md
View File

@@ -15,6 +15,43 @@ WinterCMS has one console entry point, `php artisan`. SummerCMS has two programs
The application binary is what you deploy, so everything that must run in production, such as migrations and workers, is a command of the binary rather than of `summer`. The application binary is what you deploy, so everything that must run in production, such as migrations and workers, is a command of the binary rather than of `summer`.
Run with no arguments, the binary prints its usage and every command it has, the framework's and those its plugins add; `--help` prints the same:
```sh
./bin/acme
./bin/acme --help
```
```text
Usage:
acme [command]
Available Commands:
admin:create Create an activated backend administrator
admin:reset-password Reset a backend administrator password and revoke existing tokens
admin:token:create Create a personal API token for a backend administrator
admin:token:list List personal API tokens for a backend administrator (or all)
admin:token:revoke Revoke a personal API token by id
admin:token:scopes List available personal API token scopes
deferred:purge Delete expired deferred bindings with their pending uploads and created records
greeter:hello Print the configured application name
help Help about any command
key:generate Print a fresh 32-byte base64 app.key
migrate Run plugin migrations in dependency order
migrate:rollback Roll back the last migration of a plugin
migrate:status Show per-plugin migration history
queue:clear Clear all queued jobs, by deleting all pending jobs.
queue:work Run background job workers in the foreground
route:list List registered HTTP routes
schedule:run Run the scheduler in the foreground (or once for system cron)
serve Serve the application HTTP API
Flags:
-h, --help help for acme
Use "acme [command] --help" for more information about a command.
```
## Getting help ## Getting help
Both programs list their commands with `--help`, and every command accepts `--help` for its arguments and flags: Both programs list their commands with `--help`, and every command accepts `--help` for its arguments and flags: