Quick Start ​

Know what you're doing and using a Unix-like system? Make sure you have all the prerequisites in place, then follow the steps below.

If you need more detailed instructions, we have in-depth explanations on setting up your local environment, base WordPress installation and plugins/themes.

Prerequisites ​

All setups require:

• PHP >= 8.3 (CLI)
• WP-CLI
• Node.js 18.x lts/hydrogen or above
• Composer ^2
• Bash
• cURL/Wget
• Forme Codegen ^3.0

For Valet: macOS and Valet (also requires PHP >= 8.3 as server)

For Docker: Docker Desktop (macOS/Linux/WSL)

For plugins/themes: Git, Git Cliff (optional)

Base Install With Valet ​

1. Set up a new MySQL database and make a note of the credentials

2. Change to your sites directory:

cd ~/sites

3. Install and configure a new WordPress site (you'll be prompted for database credentials):

forme base new hello-world

4. Change into the new site directory:

cd hello-world

5. Add the Valet driver if you haven't already:

cp utils/FormeServerValetDriver.php ~/.config/valet/Drivers/FormeServerValetDriver.php

6. Enable HTTPS:

valet secure

7. Visit the site e.g. https://hello-world.test and set up the admin user

Base Install With Docker ​

1. Change to your sites directory:

cd ~/sites

2. Install and configure a new WordPress site:

forme base new hello-world

3. Change into the new site directory:

cd hello-world

4. Initialise Docker configuration:

forme ketch init

5. Launch Docker:

forme ketch up

6. Visit the site at http://localhost and set up the admin user

New Plugin / Theme ​

1. Change to your repos directory:

cd ~/repos

2. Create a new plugin or theme:

# plugin
forme new plugin hello-world
# theme
forme new theme hello-world

3. Change to your base WordPress installation directory:

cd ~/sites/hello-world

4. Symlink the repo into your base installation:

# valet
forme base link ~/repos/hello-world-plugin/
# docker
forme ketch link ~/repos/hello-world-theme/
forme ketch restart

5. Update PHP dependencies:

composer update