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
20 changes: 19 additions & 1 deletion docs/sandbox-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <command>` will then work from any directory. Update the `PATH` entry if you move QuickInstall.

## Common Recipes

Create a small empty board:
Expand Down Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions src/QuickInstall/Sandbox/Web/templates/dashboard.php
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
<?php if (!$boards): ?>
<div class="empty">
<strong>No boards created</strong>
<span>Create a board below to generate its compose runtime and workspace files.</span>
<span>Create boards below. When they are ready, they will appear here.</span>
</div>
<?php endif; ?>
<div class="board-grid">
Expand Down Expand Up @@ -222,7 +222,7 @@
<div class="form-actions"><button class="primary">Fetch source</button></div>
</form>
<?php if (!$sources): ?>
<div class="empty"><strong>No sources registered</strong><span>Fetching a source will populate the local .qi source cache.</span></div>
<div class="empty"><strong>No sources registered</strong><span>Fetch a phpBB source above. When it is downloaded, it will appear here.</span></div>
<?php else: ?>
<div class="table-wrap">
<table>
Expand Down