Add a Modernized CLI to QI that runs boards in Docker containers#301
Open
iMattPro wants to merge 34 commits into
Open
Add a Modernized CLI to QI that runs boards in Docker containers#301iMattPro wants to merge 34 commits into
iMattPro wants to merge 34 commits into
Conversation
There was a problem hiding this comment.
Pull request overview
This PR introduces an experimental “Sandbox CLI” for QuickInstall that provisions disposable phpBB boards using Docker, storing generated state under .qi/ while leaving the legacy web UI unchanged.
Changes:
- Adds a
bin/qiCLI entrypoint plus a newQuickInstall\Sandboxruntime (project/workspace management, version selection, source management). - Implements board lifecycle + Docker runtime generation (compose/Dockerfile/entrypoint), including optional fixture seeding.
- Adds extension/style “drop zone” mounting (bind or copy) and documentation + ignore rules for the new workflow.
Reviewed changes
Copilot reviewed 16 out of 19 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| styles/.gitkeep | Keeps the styles/ drop zone directory in git. |
| extensions/.gitkeep | Keeps the extensions/ drop zone directory in git. |
| src/QuickInstall/Sandbox/VersionMatrix.php | Defines supported phpBB selectors and resolves them to runtime/source metadata. |
| src/QuickInstall/Sandbox/SourceProvider.php | Registers and fetches phpBB sources via Composer or Git. |
| src/QuickInstall/Sandbox/SourceService.php | Higher-level source operations (list/fetch/remove/prune) backed by .qi/sources.json. |
| src/QuickInstall/Sandbox/Project.php | Manages .qi/ workspace layout, JSON registries, and safe filesystem operations. |
| src/QuickInstall/Sandbox/DockerComposeWriter.php | Generates Docker Compose + Dockerfile + entrypoint + installer config for a board. |
| src/QuickInstall/Sandbox/BoardService.php | Orchestrates board creation and delegates runtime/runner operations. |
| src/QuickInstall/Sandbox/BoardRunner.php | Runs docker compose commands, waits for install readiness, and executes seeding. |
| src/QuickInstall/Sandbox/SeederWriter.php | Writes the phpBB in-container seeding script used by board:seed / --populate. |
| src/QuickInstall/Sandbox/ExtensionManager.php | Mount/discover/unmount/list extensions into boards and update board config. |
| src/QuickInstall/Sandbox/StyleManager.php | Mount/discover/unmount/list styles into boards and update board config. |
| src/QuickInstall/Sandbox/CommandLine.php | Minimal --key=value / --key value option parsing helper. |
| src/QuickInstall/Sandbox/Application.php | CLI command router + help text + integrates board/source/ext/style workflows. |
| bin/qi | CLI bootstrap (PHP 8+ guard + requires + runs Application). |
| docs/sandbox-cli.md | Full CLI user guide (recipes, presets, safety defaults, troubleshooting). |
| README.md | Adds “Sandbox CLI Prototype” section and updates upgrade exclusions to include .qi/ + drop zones. |
| .gitignore | Ignores .qi/, drop zones, and agent-related files while keeping .gitkeep placeholders. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+206
to
+209
| if (version_compare($phpVersion, '7.4', '>=')) | ||
| { | ||
| return ''; | ||
| } |
Comment on lines
+54
to
+66
| if ($requested === 'latest') | ||
| { | ||
| return [ | ||
| 'version' => 'latest', | ||
| 'source_key' => '3.3', | ||
| 'constraint' => '3.3.*', | ||
| 'branch' => '3.3', | ||
| 'phpbb_branch' => '3.3', | ||
| 'php' => '8.1', | ||
| 'status' => 'supported', | ||
| ]; | ||
| } | ||
|
|
| { | ||
| try | ||
| { | ||
| $mounted[] = $manager->mount($board, $path, false, true); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.