Skip to content

cli.md

Latest commit

 

History

History
30 lines (20 loc) · 1.11 KB

cli.md

File metadata and controls

30 lines (20 loc) · 1.11 KB

CLI

Atomic has a built-in CLI layer centered around Engine\Atomic\CLI\CLI.

In most projects it is used through the php atomic ... entry point.

Quick example

php atomic help

This prints the list of available framework commands, including init, access, queue, schedule, file, and other system helpers.

Plugin scaffold

php atomic plugin/make MyPlugin

This creates a user plugin under USER_PLUGINS with plugin.php, the plugin class, and an initial routes/api.php file. The default plugin directory is plugins/ at the project root.

Command groups

  • init prepares a project and framework defaults.
  • access/user/* manages config-backed users; full usage and parameters are in telemetry.md#config-user-commands, and HTTP access:<guard> behavior is in middleware.md#config-backed-access-middleware.
  • queue/* runs and inspects queue workers.
  • schedule/* runs and inspects scheduled tasks.
  • plugin/* scaffolds and manages plugins.
  • file/* provides file and storage helpers.