From 93bd83b9f894d6558ccda675715d05e466bf0857 Mon Sep 17 00:00:00 2001 From: Joe Bellus Date: Wed, 29 Jul 2020 22:57:21 -0400 Subject: [PATCH] Added command reference --- content/articles/command.md | 52 +++++++++++++++++++++++++++++ content/articles/config.md | 34 +++++++++++++++++++ content/articles/getting-started.md | 1 - themes/5Sigma/layouts/index.html | 4 +-- 4 files changed, 88 insertions(+), 3 deletions(-) create mode 100644 content/articles/command.md diff --git a/content/articles/command.md b/content/articles/command.md new file mode 100644 index 0000000..ea2dd4d --- /dev/null +++ b/content/articles/command.md @@ -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. \ No newline at end of file diff --git a/content/articles/config.md b/content/articles/config.md index a3b944e..a033272 100644 --- a/content/articles/config.md +++ b/content/articles/config.md @@ -3,6 +3,7 @@ title: "Configuration File Reference" date: 2020-07-29T20:42:50-04:00 description: "Conductor config file reference" 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 +## 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 +``` \ No newline at end of file diff --git a/content/articles/getting-started.md b/content/articles/getting-started.md index d0c237d..b98bf3d 100644 --- a/content/articles/getting-started.md +++ b/content/articles/getting-started.md @@ -3,7 +3,6 @@ title: "Getting Started" date: 2020-06-28T11:29:09-04:00 description: "A quick setup guide to get a server running" draft: false -weight: 1 version: "0.2.1" --- diff --git a/themes/5Sigma/layouts/index.html b/themes/5Sigma/layouts/index.html index 4ec0d2d..8034817 100644 --- a/themes/5Sigma/layouts/index.html +++ b/themes/5Sigma/layouts/index.html @@ -12,7 +12,7 @@

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 windows that need to be running during development.

@@ -65,7 +65,7 @@ - + View Documentation