From 059862dd47e1302cc5ca074c12ec4337c7f2986c Mon Sep 17 00:00:00 2001 From: Danny Date: Thu, 24 Apr 2025 13:38:21 +0100 Subject: [PATCH] Revised Build Command page --- Build-Command.md | 38 +++++++++++++++++++++++++++++--------- 1 file changed, 29 insertions(+), 9 deletions(-) diff --git a/Build-Command.md b/Build-Command.md index c98b112..b1f4c04 100644 --- a/Build-Command.md +++ b/Build-Command.md @@ -1,19 +1,39 @@ -Spins up a new Docker environment for your project. +# Build: `spin:up` -# Command Definition +Spins up a new Docker environment for your project, tailored for PHP development. + +## Usage ```shell loom spin:up [name] [path] [--options] ``` +### Arguments -# Usage +| Argument | Required | Description | +|----------|----------|---------------------------------------------------------------| +| name | ✅ | Name for your environment (used as Docker container prefix). | +| path | ✅ | Path to your project's root directory (absolute path or `.`). | -## Arguments +### Options -| Argument | Required | Valid Options | -|----------|-----------|------------------------------------------------------------------------| -| name | ✅ | Valid string (no special characters). Full stops are allowed. | -| path | ✅ | Absolute path to your projects root, or `.` for the current directory. | +| Option | Description | Example/Accepted Values | +|---------------------|------------------------------------------------|-------------------------| +| --php | Choose PHP version | `8.3`, `8.4`, etc. | +| --disable-xdebug | Disable Xdebug in PHP container | (flag, no value) | +| --database | Select database (currently only sqlite) | `sqlite` | +| --disable-database | Disable database container | (flag, no value) | +| --disable-server | Exclude Nginx web server | (flag, no value) | +| --node | Set Node.js version | `20`, `23` | +## What it Does -## Options \ No newline at end of file +- Reads configuration and builds required project files (Dockerfile, docker-compose). +- Spins up the PHP (and optionally Nginx/database) containers for your project. +- Automatically mounts your project directory. + +## Notes + +- Container configuration is determined only at build time. + **To apply changes to config or options, destroy and rebuild your environment.** +- Project name becomes the Docker prefix (e.g., `projectname-php`). +- Requires Docker running. \ No newline at end of file