spinup

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

★ 14 Open GitHub ↗

Development process runner: simple, flexible, fast. Unix-friendly!

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# spinup

Spinup is a simple process runner for use during development, designed for bringing up all necessary servers and file-watchers with a single command.

Using Spinup is as simple as creating a `spin.up` file containing one shell command per line in your project's root directory and then running the `spinup` executable.

Supports process groups, per-process kill signals, daemonisation, environment variables (inc. dotenv), and configurable output formatting.

![spinup demo](https://raw.githubusercontent.com/jaz303/spinup/master/demo.gif)

Spinup is pretty customisable. Let's take a look at an example config file:

```
# (lines beginning with # are comments...)

# Directives are denoted by "!" and come before any commands
# Directives are used to configure global settings.
# (!prefix sets the prefix for each line of output)
!prefix [%p]

# Run the webserver
python -m SimpleHTTPServer 9000

# Compile some JavaScript
watchify -o bundle.js main.js

# Per-command options are prefixed with @ and will be applied to the next command
# (@cd sets the working directory for the next command)
@cd www
php -S 127.0.0.1:8000

# Shell arguments are parsed correctly...
echo "let's test" "the argument" parser

# ...and environment variables can be used too:
echo "your home directory is:" $HOME
```

`spinup` will run until all child processes have exited. Hit `Ctrl-C` to send `SIGTERM` to any that are still running (this kill signal can be customised on a per-command basis, see the `@kill` option below).

`dotenv` is also supported; any environment variables defined within `.env` will made available to the commands listed in `spin.up`.

## Installation

Spinup can be installed globally, or run locally via `npx`. To install globally:

```shell
$ npm install -g spinup
```

For local usage:

```shell
$ npm install spinup
$ touch spin.up
$ npx spinup
```

## Usage

```
$ spinup [-g | --group $group_list] [config]
```

- `-g | --group`: optional comma separated list of groups to run; can be specified multiple times
  - `config`: optional path to configuration file, defaults to `./spin.up`.

## Directives

Leading lines of the `spin.up` file can include _directives_. Directives begin with a `!`, followed by the name of the directive and then its arguments.

### `!default`

Sets an environment variable if it does not already exist.

```
!default PORT 3000
echo $PORT
```

```shell
$ spinup
3000
$ PORT=5000 spinup
5000
```

See also: `!set`, to unconditionally set an environment variable.

### `!noprefix`

Do not add a prefix onto each line of output.

spinup

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README