website/content/articles/command.md

56 lines
973 B
Markdown
Raw Normal View History

2020-07-30 02:57:21 +00:00
---
title: "Command Reference"
2022-09-25 07:23:44 +00:00
date: 2022-09-10T22:45:07-04:00
2020-07-30 02:57:21 +00:00
description: "Full command usage"
draft: false
weight: 1
2022-09-25 07:23:44 +00:00
version: "2.0.0"
2020-07-30 02:57:21 +00:00
---
# Comamnd Reference
2022-09-25 07:23:44 +00:00
The command can be used to launch any number of configured objects using a space separated list.
2020-07-30 02:57:21 +00:00
2022-09-25 07:23:44 +00:00
## Listing configured objects
2020-07-30 02:57:21 +00:00
2022-09-25 07:23:44 +00:00
Running the command with no arguments will list all configured groups, components, and tasks that are configured in the configuration file.
2020-07-30 02:57:21 +00:00
```sh
2022-09-25 07:23:44 +00:00
conductor
2020-07-30 02:57:21 +00:00
```
2022-09-25 07:23:44 +00:00
## Launching a specific item
2020-07-30 02:57:21 +00:00
2022-09-25 07:23:44 +00:00
Launchign a group
2020-07-30 02:57:21 +00:00
```sh
2022-09-25 07:23:44 +00:00
conductor groupname
2020-07-30 02:57:21 +00:00
```
2022-09-25 07:23:44 +00:00
Launching a specific component
2020-07-30 02:57:21 +00:00
```sh
2022-09-25 07:23:44 +00:00
conductor componentname
2020-07-30 02:57:21 +00:00
```
2022-09-25 07:23:44 +00:00
Launching a specific root level task
2020-08-27 18:22:27 +00:00
```sh
2022-09-25 07:23:44 +00:00
conductor taskname
2020-08-27 18:22:27 +00:00
```
2022-09-25 07:23:44 +00:00
Launching a compoennt level task
2020-08-27 18:22:27 +00:00
```sh
2022-09-25 07:23:44 +00:00
conductor componentname:taskname
2020-08-27 18:22:27 +00:00
```
2022-09-25 07:23:44 +00:00
## Launching Multiple Specific Items
2020-07-30 02:57:21 +00:00
2022-09-25 07:23:44 +00:00
Multiple objects can be ran with a space separated list. Groups, components, and tasks can be used interchangably.
2020-07-30 02:57:21 +00:00
```sh
2022-09-25 07:23:44 +00:00
conductor mygroup mytask mycomponent mycomponent:subtask
2020-07-30 02:57:21 +00:00
```