From 6b1dd21b0df196641a77bb1d733cbf899feb620e Mon Sep 17 00:00:00 2001 From: Matt Friedman Date: Thu, 23 Jul 2026 06:21:46 -0700 Subject: [PATCH] Add info about adding bi/qi to PATH Reword some web-ui text --- docs/sandbox-cli.md | 20 ++++++++++++++++++- .../Sandbox/Web/templates/dashboard.php | 4 ++-- 2 files changed, 21 insertions(+), 3 deletions(-) diff --git a/docs/sandbox-cli.md b/docs/sandbox-cli.md index 15dd8727..98e819ab 100644 --- a/docs/sandbox-cli.md +++ b/docs/sandbox-cli.md @@ -86,6 +86,24 @@ Arguments and options are identical with every launcher. Run commands from the Q Docker Desktop on Windows must use its WSL 2 or Hyper-V Linux-container backend rather than Windows containers. +### Optional PATH setup + +You can run QuickInstall from any directory by using an absolute path to `bin/qi` or `bin/qi.cmd`. CLI users may instead add the project's absolute `bin` directory to their user `PATH`. + +For bash or zsh on macOS and Linux, add this to your shell profile using **the real project path**: + +``` +export PATH="/path/to/quickinstall/bin:$PATH" +``` + +On Windows, add this through User Environment Variables using **the real project path**: + +``` +C:\path\to\quickinstall\bin +``` + +Open a new terminal afterward; `qi ` will then work from any directory. Update the `PATH` entry if you move QuickInstall. + ## Common Recipes Create a small empty board: @@ -496,7 +514,7 @@ On Windows, also confirm Docker Desktop is using Linux containers. `php bin/qi d #### Composer command fails -QuickInstall uses composer from PATH first, then `composer.phar` from the project root. Restore `composer.phar` or install Composer if both are missing. +QuickInstall uses composer from `PATH` first, then `composer.phar` from the project root. Restore `composer.phar` or install Composer if both are missing. #### View container logs diff --git a/src/QuickInstall/Sandbox/Web/templates/dashboard.php b/src/QuickInstall/Sandbox/Web/templates/dashboard.php index 491d3991..66137e3a 100644 --- a/src/QuickInstall/Sandbox/Web/templates/dashboard.php +++ b/src/QuickInstall/Sandbox/Web/templates/dashboard.php @@ -63,7 +63,7 @@
No boards created - Create a board below to generate its compose runtime and workspace files. + Create boards below. When they are ready, they will appear here.
@@ -222,7 +222,7 @@
-
No sources registeredFetching a source will populate the local .qi source cache.
+
No sources registeredFetch a phpBB source above. When it is downloaded, it will appear here.