@fneira/stack-up

Stack-up

Stack-up is a simple tool written in JavaScript that allows you to run multiple programs concurrently in the terminal. It is designed to be configurable through a json file, enabling you to specify the programs you want to run, their working directories, and commands.

Using with npx

You can use stack-up without installing it globally by using npx:

npx @fneira/stack-up modules.json

This will download the latest version of stack-up and run it with the specified module.json file.

Installing globally

You can also install stack-up globally to use it as a command line tool:

npm install -g @fneira/stack-up

After installing it globally, you can run stack-up from any directory:

stack-up modules.json

Installation

Before using stack-up, ensure you have Node.js installed on your system. You can download it here.

1. Clone this repository:

git clone https://github.com/Bubexel/stack-up.git

Navigate to the project directory:

cd stack-up

Install dependencies:

npm install

Configuration

To use stack-up, you'll need to create a module.json file or name you wish. This file will contain an array of objects, each representing a program you want to run concurrently. Here's an example of json file:

[
    {
        "name": "My program",
        "enabled": true,
        "workingDir": "/home/user/myprogram/",
        "command": "npm run --prefix {{workingDir}} start"
    },
    {
        "name": "Another program",
        "enabled": true,
        "workingDir": "/path/to/another/program/",
        "command": "cd {{workingDir}} && node index.js"
    }
]

• name: A descriptive name for your program.
• enabled: Set to true to enable the program to run as default option, or false to disable it.
• workingDir: The working directory where the program should be executed from.
• command: The command to run the program. Use {{workingDir}} as a placeholder for the orkingDir.

You can add as many objects as needed to run multiple programs concurrently.

Usage

Once you have your module.json file configured, you can run stack-up:

npm start modules.json

This will start all the programs specified in the module.json file concurrently in same terminal windows using the concurrently library.

Author

• Ferran Neira

License

This project is licensed under the MIT License - see the LICENSE file for details.