Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,6 @@ QuickInstall now includes a Docker-based CLI for creating local phpBB test board
```bash
php bin/qi init
php bin/qi board:create test --phpbb 3.3 --db mariadb --port 8081 --populate extension-dev
php bin/qi board:start test
```

The QuickInstall CLI targets phpBB 3.2+ installer-based boards. phpBB 3.0/3.1 remain legacy-web-app territory and are not planned for the QuickInstall CLI.
Expand Down
19 changes: 10 additions & 9 deletions docs/sandbox-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,10 @@ Create your first board:

```bash
php bin/qi board:create demo --phpbb 3.3 --db mariadb --port 8081 --populate none
php bin/qi board:start demo
```

When creation finishes, QuickInstall asks whether to start the board.

Open:

```text
Expand All @@ -39,7 +40,7 @@ Admin login:
admin / password
```

That is the normal workflow. `board:create` downloads the requested phpBB source if needed, writes Docker config, and prepares the board. `board:start` starts the board containers with Docker Compose, installs phpBB, applies the selected seed preset once, and waits until the board URL responds before printing the final URL.
That is the normal workflow. `board:create` downloads the requested phpBB source if needed, writes Docker config, prepares the board, and offers to start it. Starting a board starts the containers with Docker Compose, installs phpBB, applies the selected seed preset once, and waits until the board URL responds before printing the final URL.

If you ever need help with commands, run:

Expand All @@ -53,35 +54,30 @@ Create a small empty board:

```bash
php bin/qi board:create clean --phpbb 3.3 --db mariadb --port 8081 --populate none
php bin/qi board:start clean
```

Create a board with extension-development fixtures:

```bash
php bin/qi board:create extdev --phpbb 3.3.17 --db mariadb --port 8082 --populate extension-dev
php bin/qi board:start extdev
```

Create a board with phpBB debug output enabled:

```bash
php bin/qi board:create debug --phpbb 3.3 --db mariadb --port 8085 --populate extension-dev --debug
php bin/qi board:start debug
```

Create an older supported phpBB 3.2 board:

```bash
php bin/qi board:create old --phpbb 3.2 --db mariadb --port 8083 --populate tiny
php bin/qi board:start old
```

Create an experimental master branch board:

```bash
php bin/qi board:create alpha --phpbb master --db mariadb --port 8084 --populate tiny
php bin/qi board:start alpha
```

List boards (shows all created boards and their statuses):
Expand All @@ -90,6 +86,12 @@ List boards (shows all created boards and their statuses):
php bin/qi board:list
```

Start a board:

```bash
php bin/qi board:start demo
```

Stop or remove a board:

```bash
Expand Down Expand Up @@ -375,10 +377,9 @@ docker compose -f .qi/runtime/demo/compose.yml logs db

#### Reset a board completely

Use this when a board's files, database, or generated Docker runtime are no longer worth repairing. Destroying a board removes its generated state, so create and start it again afterward.
Use this when a board's files, database, or generated Docker runtime are no longer worth repairing. Destroying a board removes its generated state, so create it again afterward.

```bash
php bin/qi board:destroy demo
php bin/qi board:create demo --phpbb 3.3 --db mariadb --port 8081 --populate none
php bin/qi board:start demo
```