spinup

Spinup

Quickly spin up your multi command projects.

Installation

Pre-requisites

To run spinup you need to have go installed on your system. You can download it from the official website.

Installation

To install spinup you can use the following command:

go install github.com/iskandervdh/spinup

Afterwards you can initialize spinup using the following command:

spinup init

This will create a spinup folder in your .config folder with the configuration files needed to run spinup.

Configuration

Commands

Adding a command

To add a command template you can use the following command:

spinup command add <name> <command>

Example:

spinup command add example "npm run dev"

Removing a command

To remove a command template you can use the following command:

spinup command remove|rm <name>

Example:

spinup command remove example

Listing commands

To list all the command templates you can use the following command:

spinup command list|ls

Custom Variables

Commands are templates, so we can use variables that are then defined in the project configuration.

Example:

spinup command add example "npm run dev -- --port {{port}}"

port and domain are reserved variables that are used to define the port and domain of the project. These are required to be when adding a project.

More information on variables can be found in the Variables section.

Projects

Adding a project

To add a project you can use the following command:

spinup project add <name> <domain> <port> [commands...]

This will create a configuration for the project in the projects.json file in your .config/spinup folder.

Example:

spinup project add example example.local 8001 example1 example2

Removing a project

To remove a project you can use the following command:

spinup project remove|rm <name>

Example:

spinup project remove example

Listing projects

To list all the projects you can use the following command:

spinup project list|ls

Variables

You can add custom variables to the project configuration file. These variables can be used in the command templates.

spinup variable add <project> <name> <value>

Example:

If we define a command template like this:

spinup command add "example" "npx vite -- --loglevel {{loglevel}}"

We can add a variable to the project configuration like this:

spinup variable add example loglevel silent

spinup run example

Usage

To run a project you can use the following command:

spinup run <project>

This will run the commands defined in the configuration for the project.

Possible future features

• Commands to add/remove commands from a project.
• Add option to set the path of the project to use so it can be run anywhere.
• Don't require concurrently to be installed.
• Use interactive CLI.
• Add tests.
• Better solution for showing what commands are available.
• Make adding domain aliases possible.
• Adding certificates to enable https for the project.
• Add option to set the path of the nginx folder to use.
• GUI?