README

This repository holds the CLI functionality for PHP.Gt/WebEngine, exposed via the gt command line.

The following commands are exposed:

• gt add - add a page, API endpoint or cron script from a template
• gt create - create a new WebEngine application
• gt test - run configured PHP and JavaScript test suites
• gt serve - run the inbuilt development server
• gt build - compile client-side assets
• gt cron - invoke scripts or static functions at regular intervals
• gt run - run all background scripts at once - a combination of serve, build --watch and cron --watch --now
• gt deploy - instantly deploy your application to the internet

gt add

Use gt add type name [template] to create new files in the current project.

Supported types:

• page
• api
• cron

Examples:

• gt add page about
• gt add api users
• gt add cron cleanup
• gt add page about multi-column

type and name are required. template is optional.

Built-in templates

If no template name is provided, gt add copies the built-in templates from this package:

• src/Template/page/template.html -> page/<name>.html
• src/Template/page/template.php -> page/<name>.php
• src/Template/api/template.php -> api/<name>.php
• src/Template/api/template.json -> api/<name>.json
• src/Template/cron/template.php -> cron/<name>.php

If a template file contains {{name}}, it is replaced with the provided name.

Project templates

If a template name is provided, files are loaded from the current working directory instead:

• <type>/_template/<template>.*

For example:

• gt add page about multi-column

This will copy:

• page/_template/multi-column.html -> page/about.html
• page/_template/multi-column.php -> page/about.php

The same lookup rule applies for api, cron, and future types that may be added later.

Proudly sponsored by

JetBrains Open Source sponsorship program