Dataphyre commands are explicit maintenance and development tools. They do not run on web requests.
Use php <script> --help for PHP scripts and -Help for PowerShell scripts.
Command examples are relative to the Dataphyre package root. In an embedded
install that is usually common/dataphyre; in a Composer install it is usually
vendor/dataphyre/dataphyre. Set DATAPHYRE_PROJECT_ROOT when a runtime
command is executed from a Composer vendor install and needs to find the
consumer project root.
| Command | Purpose |
|---|---|
php vendor/dataphyre/dataphyre/installer/init_consumer.php --root=. |
Copy the minimal consumer files into a Composer project. |
php common/dataphyre/installer/install.php init --root=<project> |
Create dataphyre.project.json for an installer-managed project. |
php common/dataphyre/installer/install.php install --root=<project> [--source=<path>] |
Copy the configured Dataphyre source into common/dataphyre and refresh the lock. |
php common/dataphyre/installer/install.php update --root=<project> [--source=<path>] |
Update the managed Dataphyre tree and refresh the lock. |
php common/dataphyre/installer/install.php lock --root=<project> |
Recompute dataphyre.lock after intentional installer-managed changes. |
php common/dataphyre/installer/install.php verify --root=<project> |
Verify the managed tree against dataphyre.lock; check is an alias. |
php common/dataphyre/installer/install.php doctor --root=<project> |
Print installer state for diagnostics. |
| Command | Purpose |
|---|---|
php runtime/modules/routing/kernel/compile_app_routes.php <application> |
Compile routes for an application. |
php runtime/modules/mvc/kernel/route_list.php [app] [--json] |
List MVC routes as a table or JSON. |
php runtime/modules/mvc/kernel/cache_routes.php [app] |
Write the configured MVC route manifest cache. |
php runtime/modules/mvc/kernel/clear_cached_routes.php [app] |
Remove the configured MVC route manifest cache. |
php runtime/modules/sql/kernel/scaffold_table_artifacts.php --application=example_app --entity=Machine --table=machines --primary-key=machine_id --columns=machine_id,tenant_id,name,status |
Generate app-owned SQL table artifacts. |
php runtime/modules/permission/kernel/permission_check.php --manifest=<path> |
Audit a permission manifest. |
| Command | Purpose |
|---|---|
php runtime/modules/panel/kernel/panel_regression.php --example |
Run the route-free Panel regression example suite. |
php runtime/modules/panel/kernel/panel_field_catalog_check.php |
Check Panel field, renderer, theme, and asset catalog behavior. |
php runtime/modules/mvc/kernel/mvc_regression.php |
Run the route-free MVC, Routing, controller, middleware, and module integration regression harness. |
The MCP server is a stdio process started by an MCP client, not a normal interactive command:
| Command | Purpose |
|---|---|
php runtime/modules/mcp/kernel/dataphyre_mcp.php |
Start the Dataphyre MCP stdio server. |
php runtime/modules/mcp/kernel/dataphyre_mcp.php --allow-unsafe |
Start the server with unsafe-gated tools explicitly enabled. |
For client JSON examples and safety boundaries, see MCP server.