# Installation

Binaries can be downloaded for windows, Linux, or MacOS

## Homebrew

On MacOS Conductor can be installed via Homebrew

    brew tap 5sigma/tap
    brew install conductor

# Setting up a project

To setup a project for conductor you need to create a `conductor.yaml` somewhere in your project tree. We will assume you have a stack that consists of 2 seperate components in a directory structure that looks like this:

    /project
        /frontend/
        /backend/
        /support_service/

## Settting up a conductor.yml

Conductor will search for a `conductor.yaml` anywhere in or above the current working directory. We will put the configuration in the root `/project/` folder so it is accessible from any of the component projects.

For more information see the full Config documentation

An example of a minimal configuration file could look like this:

    components:
    - name: frontend
      start:
        command: npm
        args:
        - start
    - name: backend
      start:
        command: npm
        args:
        - start
    - name: support
      start:
        command: python
        args:
        - main.py

Now from the project folder or any folder below it we can launch all 3 components using:

    conductor run

Alternatively, we can run a single component by name:

    conductor backend

last modified Sunday, June 28, 2020
Configuration File Reference
Conductor config file reference
Conductor is maintained by 5Sigma. Source code is available at Github.