73 lines
No EOL
2 KiB
Markdown
73 lines
No EOL
2 KiB
Markdown
<p>
|
|
<img src="./header.jpg" alt="Loom Spinner CLI Header Image & Logo" style="width: 100%; height: auto;">
|
|
</p>
|
|
|
|
# Loom Spinner CLI
|
|
|
|
<p>
|
|
<img src="https://img.shields.io/badge/Version-1.0.0-blue" alt="Version 1.0.0">
|
|
</p>
|
|
|
|
A streamlined environment management tool for PHP developers.
|
|
|
|
Loom Spinner makes it easy to launch minimal, thoughtfully pre-configured Docker containers for PHP development - helping
|
|
you enjoy a fast, consistent, and hassle-free workflow.
|
|
|
|
Run simple commands from anywhere on your system to manage your environments.
|
|
|
|
# At a Glance
|
|
|
|
Effortlessly create custom Docker environments for each of your PHP projects. Out of the box, Loom Spinner provides:
|
|
|
|
- **PHP 8.4** (includes XDebug & OpCache)
|
|
- **Nginx**
|
|
- **SQLite3**
|
|
- **NodeJS 23** (Node, NPM, & NPX)
|
|
|
|
Your project directory is automatically mounted to the PHP container, and the `public` directory is served via Nginx at `http://localhost:<nginx-port>`. Access the container directly from your terminal to execute unit tests or other commands—all within an isolated environment.
|
|
|
|
> **Note:** Loom Spinner CLI is in early development. For now, only SQLite is supported as the database, but more options are on the way in future updates.
|
|
|
|
# Installation
|
|
|
|
**Requirements:**
|
|
- Composer
|
|
- Docker Desktop or Docker Engine
|
|
|
|
To install globally, run:
|
|
|
|
```shell
|
|
composer global require loomlabs/loom-spinner-cli
|
|
```
|
|
|
|
# Usage
|
|
|
|
Start Docker, then launch your project environment:
|
|
|
|
```shell
|
|
cd /path/to/my-project
|
|
loom spin:up my-project .
|
|
```
|
|
|
|
Check which ports your containers are using via Docker Desktop or by running `docker ps`.
|
|
|
|
Once running, your project's public directory is accessible at `http://localhost:<nginx-container-port>`—you're ready to go!
|
|
|
|
## Managing Your Environment
|
|
|
|
To stop your containers:
|
|
|
|
```shell
|
|
loom spin:stop my-project
|
|
```
|
|
|
|
To start them again:
|
|
|
|
```shell
|
|
loom spin:start my-project
|
|
```
|
|
|
|
Loom Spinner can be further customized with a set of simple configuration options. For a more detailed quick-start guide
|
|
or advanced configuration tips, check out the project wiki.
|
|
|
|
Happy spinning! 🧵 |