LoomLabs/loom-spinner-cli
1
0
Fork 0
Code Issues Pull requests Projects Releases 8 Packages Wiki Activity

Revised Build Command page

Daniel Winning 2025-04-24 13:38:21 +01:00
parent f40475479a
commit 059862dd47
1 changed files with 29 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
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
- 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.