Added command reference

This commit is contained in:
Joe Bellus 2020-07-29 22:57:21 -04:00
parent eb58f1872d
commit 93bd83b9f8
4 changed files with 88 additions and 3 deletions

View File

@ -0,0 +1,52 @@
---
title: "Command Reference"
date: 2020-07-29T22:45:07-04:00
description: "Full command usage"
draft: false
weight: 1
version: "0.2.1"
---
# Comamnd Reference
## Launching a stack
The full stack listed in a configuration can be run by running the bare conductor command:
```sh
conductor
```
The run subcommand without arguments can also be used:
```sh
conductor run
```
## Launching via tags
To run a group of components without launching the entire stack specify tags in the component configuration. One or more tags can be specified to run only components that have at least one of the specified tags.
```sh
conductor run --tags web,frontend
```
## Launching by name
The name of a component can be used as a subcommand to launch that component by itself:
```sh
conductor my-component
```
## Setup a stack
Given a configuration file you can clone and initialize an entire stack. This can be useful for bootstrapping a new computer/developer.
From a folder with the conductor.yaml run:
```sh
conductor setup
```
Each component will be cloned into subfolders named after their component name (unless path is set) and their init commands will be run.

View File

@ -3,6 +3,7 @@ title: "Configuration File Reference"
date: 2020-07-29T20:42:50-04:00 date: 2020-07-29T20:42:50-04:00
description: "Conductor config file reference" description: "Conductor config file reference"
version: "0.2.1" version: "0.2.1"
weight: 1
--- ---
@ -65,3 +66,36 @@ component itself.
* **dir** - An optional working directory override if the command should be ran somewhere other than the component path * **dir** - An optional working directory override if the command should be ran somewhere other than the component path
## Full example config:
```yaml
name: My Web Application
components:
- name: frontend
color: Blue
tags:
- core
start:
- command: npm
args:
- start
init:
- command: npm
args:
- install
- name: backend
color: Purple
tags:
- core
start:
- command: mix
args:
- phx.server
init:
- command: mix
args:
- deps.get
- command: mix
args:
- compile
```

View File

@ -3,7 +3,6 @@ title: "Getting Started"
date: 2020-06-28T11:29:09-04:00 date: 2020-06-28T11:29:09-04:00
description: "A quick setup guide to get a server running" description: "A quick setup guide to get a server running"
draft: false draft: false
weight: 1
version: "0.2.1" version: "0.2.1"
--- ---

View File

@ -12,7 +12,7 @@
</h1> </h1>
<p style="font-size: 1.2em; color: white"> <p style="font-size: 1.2em; color: white">
Conductor helps launch and manage the environment when developing applications that have multiple components. Conductor helps launch and manage the environment when developing applications that have multiple components.
It can be configured to launch an applications stack in part, or in full, and manage the environment. It can be configured to launch an applications stack in part, or in full, and manage environment settings.
This helps keep application specific environment variables out of dotfiles and reduce the number of terminal This helps keep application specific environment variables out of dotfiles and reduce the number of terminal
windows that need to be running during development. windows that need to be running during development.
</p> </p>
@ -65,7 +65,7 @@
</div> </div>
</div> </div>
<div class="ui hidden divider"></div> <div class="ui hidden divider"></div>
<a class="ui secondary basic button" href="/articles/getting-started"> <a class="ui secondary basic button" href="/articles">
View Documentation View Documentation
</a> </a>
</div> </div>