Revised Command pages
parent
017e55d412
commit
33633c468c
3 changed files with 85 additions and 1 deletions
|
@ -1 +1,29 @@
|
||||||
> **This command is not yet implemented.**
|
# Destroy: `spin:down`
|
||||||
|
|
||||||
|
Destroys (removes) your Docker-based development environment for a given project, cleaning up containers and associated
|
||||||
|
resources.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
```shell
|
||||||
|
loom spin:down [name]
|
||||||
|
```
|
||||||
|
### Arguments
|
||||||
|
|
||||||
|
| Argument | Required | Description |
|
||||||
|
|----------|----------|---------------------------------------------|
|
||||||
|
| name | Yes | Name of the environment to remove |
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
(None)
|
||||||
|
|
||||||
|
## What it Does
|
||||||
|
|
||||||
|
- Stops any running containers for this environment.
|
||||||
|
- Removes the environment completely, including its containers and network.
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
|
||||||
|
- You must run `spin:down` before rebuilding an environment with new configuration.
|
||||||
|
- This does **not** delete your actual project files or source code.
|
|
@ -0,0 +1,28 @@
|
||||||
|
# Start: `spin:start`
|
||||||
|
|
||||||
|
Starts the Docker containers for your environment, if they've been previously spun up.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
```shell
|
||||||
|
loom spin:start [name]
|
||||||
|
```
|
||||||
|
### Arguments
|
||||||
|
|
||||||
|
| Argument | Required | Description |
|
||||||
|
|----------|----------|--------------------------------|
|
||||||
|
| name | Yes | Name of your environment |
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
(None)
|
||||||
|
|
||||||
|
## What it Does
|
||||||
|
|
||||||
|
- Starts containers for your project environment (if they exist).
|
||||||
|
- Leaves configuration unchanged; doesn't rebuild.
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
|
||||||
|
- Environment must already be built with `spin:up`.
|
||||||
|
- Use after running `spin:stop`.
|
|
@ -0,0 +1,28 @@
|
||||||
|
# Stop: `spin:stop`
|
||||||
|
|
||||||
|
Gracefully stops running containers for your environment (without removing them).
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
```shell
|
||||||
|
loom spin:stop [name]
|
||||||
|
```
|
||||||
|
### Arguments
|
||||||
|
|
||||||
|
| Argument | Required | Description |
|
||||||
|
|----------|----------|--------------------------------|
|
||||||
|
| name | Yes | Name of your environment |
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
(None)
|
||||||
|
|
||||||
|
## What it Does
|
||||||
|
|
||||||
|
- Stops all containers for your project environment.
|
||||||
|
- Leaves containers and project resources intact (can be started again).
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
|
||||||
|
- Use when you want to pause but not remove your environment.
|
||||||
|
- Start again with `spin:start`.
|
Loading…
Add table
Reference in a new issue