You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-3Lines changed: 9 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,15 +10,15 @@ A single application to spin up your entire dev stack.
10
10
11
11
## About
12
12
13
-
`StackUp` is a tool for developers that automates the process of spinning up complicated development environments. It allows you to defines a series of steps that execute in order on startup and shutdown, as well as a list of server processes that should be started. Additionally, `StackUp` runs an event loop while the server processes are running, allowing you to run tasks on a cron schedule.
13
+
`StackUp` is a scriptable tool for developers that automates the process of spinning up complicated development environments. It allows you to defines a series of steps that execute in order on startup and shutdown, as well as a list of server processes that should be started. Additionally, `StackUp` runs an event loop while the server processes are running, allowing you to run tasks on a cron schedule.
14
14
15
15
One of the key features of this application is its ability to automate routine tasks. With a simple configuration, you can define a sequence of tasks that your project requires, such as starting containers, running database migrations, or seeding data. This automation not only saves you time but also ensures consistency across your development environment.
16
16
17
-
It also includes a robust precondition system. Before doing anything, checks can be performed to ensure everything is set up correctly. This feature helps prevent common issues that occur when the environment is not properly configured.
17
+
It also includes a robust, scriptable precondition system. Before doing anything, checks can be performed to ensure everything is set up correctly. This feature helps prevent common issues that occur when the environment is not properly configured.
18
18
19
19
## Running StackUp
20
20
21
-
To run `StackUp`, simply run the binary in a directory containing a `stackup.yaml` configuration file:
21
+
To run `StackUp`, simply run the binary in a directory containing a `stackup.yaml`or `stackup.dist.yaml`configuration file:
22
22
23
23
```bash
24
24
stackup
@@ -36,6 +36,12 @@ To generate a new configuration file to get started, run `init`:
36
36
stackup init
37
37
```
38
38
39
+
`StackUp` checks if it is running the latest version on startup. To disable this behavior, use the `--no-update-check` flag:
40
+
41
+
```bash
42
+
stackup --no-update-check
43
+
```
44
+
39
45
## Configuration
40
46
41
47
The application is configured using a YAML file named `stackup.yaml` and contains five sections: `preconditions`, `tasks`, `startup`, `shutdown`, and `scheduler`.
0 commit comments