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

Update README

Browse source
This commit is contained in:
Daniel Winning 2025-04-14 15:25:40 +01:00
parent 7f2fb2bbf3
commit e287c63b4c
1 changed files with 23 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
README.md
View file

@ -48,29 +48,44 @@ Creates a new PHP development environment and mounts your project files.
> **Required?** ❌ > **Required?** ❌
> >
> Set which version of Node to install in your container. Is ignored if the `--disable-node` flag is > Set which version of Node to install in your container. Is ignored if the `--disable-node` flag is
> passed, or if Node is disabled in your projects `spinner.yaml` file. Equivalent to setting `options.environment.node.version = x` > passed, or if Node is disabled in your projects `spinner.yaml` file. Equivalent to setting
> in your projects Spinner config. > `options.environment.node.version: x` in your projects Spinner config.
> #### Option: --database
>
> **Required?** ❌
>
> Set which database driver to use with your environment. The default (and currently only) database driver is `sqlite3`.
> Accepted values are currently `sqlite` and `sqlite3`. If using the default, SQLite is installed inside your PHP
> container and a mapping created to the `/sqlite` directory in your project. This argument is ignored if
> `--disabled-database` is set.
> #### Option: --disable-database
>
> **Required?** ❌
>
> Does not install a database with your environment. Equivalent to setting `options.environment.database.enabled: false`
> in your Spinner config.
> #### Option: --disable-node > #### Option: --disable-node
> >
> **Required?** ❌ > **Required?** ❌
> >
> Disables Node for your environment, so it isn't included in your PHP container. Equivalent to setting `options.environment.node.enabled = false` > Disables Node for your environment, so it isn't included in your PHP container. Equivalent to setting
> in your Spinner config. > `options.environment.node.enabled: false` in your Spinner config.
> #### Option: --disable-server > #### Option: --disable-server
> >
> **Required?** ❌ > **Required?** ❌
> >
> Does not install a webserver (so no Nginx). Useful if you just need a PHP container to run > Does not install a webserver (so no Nginx). Useful if you just need a PHP container to run unit tests or something.
> unit tests or something.
> #### Option: --disable-xdebug > #### Option: --disable-xdebug
> >
> **Required?** ❌ > **Required?** ❌
> >
> Do not install XDebug in your environment. Equivalent to setting `options.environment.php.xdebug = false` > Do not install XDebug in your environment. Equivalent to setting `options.environment.php.xdebug = false` in your
> in your project Spinner config. > projects Spinner config.
## XDebug Setup ## XDebug Setup