rox-cli is both an executable binary that can be run, and a library that can be used in Rust programs.

Installing the `rox` executable

Assuming you have Rust/Cargo installed, run this command in a terminal:

cargo install rox-cli

It will make the rox command available in your PATH if you've allowed the PATH to be modified when installing Rust. cargo uninstall rox-cli uninstalls.

Adding `rox` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add rox-cli

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

rox-cli = "0.8.2"

The rox library will be automatically available globally. Read the rox library documentation.

Back to the crate overview.

Readme

Rox

Rox is a robust developer workflow framework inspired by Nox, Make & cargo-make

Rox gives you the ability to build your own devtools CLI using YAML files, check CI pipeline statuses from your terminal, and even read documentation. Tasks and Pipelines are dynamically added to the CLI as subcommands at runtime. The flexibility of rox intends to makes it easier for dev teams to standardize their workflows without writing endless "glue" scripts.

The subcommands and their help messages are automatically populated at runtime from the name and description of each task or pipeline.

See synthesizer for an example of usage in a real project.

Why Rox?
Installation
Roxfile Syntax
- CI
- Docs
- Templates
- Tasks
- Pipelines
- Logs
Putting it all Together

Why Rox?

Rox was created for the purpose of making building and developing applications easier. It is designed to focus on extensiblity, performance, and documentation. Here are a few of the key features that help Rox achieve that goal:

Dynamically Generated CLI: Rox's subcommands are dynamically added to the CLI at runtime. Configuration is handled entirely via YAML.
Powerful Primitives: Using a combination of Rox's primitives (Tasks, Pipelines and Templates, etc.) it is possible to handle virtually any use-case with minimal boilerplate.
Documentation as a First-Class Feature: Names and descriptions are automatically injected into the CLI at runtime, so your help command is always accurate. This helps developers understand what various tasks and pipelines do without needing to dive into the code or understand complex bash.
Performant: Minimal overhead and native executables for a variety of architectures and operating systems.
Efficient: By utilizing pipeline stages and parallel execution, developers are empowered to make use of multi-core machines to speed up build and development tasks.
User-Friendly: Task results are shown to the user in an easy-to-consume table format along with useful metadata. This makes debugging easier, and shows potential bottlenecks in build steps.

Installation

Rox can be installed via binaries provided with each release here. As an alternative, it can also be installed via cargo with cargo install rox-cli.

Roxfile Syntax

Rox requires a YAML file with the correct format and syntax to be parsed into a CLI. This file is expected to be at ./roxfile.yml by default but that can be overriden with the -f flag at runtime.

CI

Rox allows developers to see CI pipeline results from their terminal with some minimal configuration.

It will automatically get the CI pipeline for the current branch.

ci:
  # The CI provider to use. Currently only GitHub Actions is supported.
  provider: github_actions
  repo_owner: ThomasLaPiana
  repo_name: rox
  # The name of the env var with the stored PAT (Personal Access Token)
  token_env_var: GITHUB_TOKEN

Docs

Specifying docs within your roxfile allows you to keep track of various types of documentation for your project.

url -> Opens a webbrowser pointed at the URL provided in the path
markdown -> Opens the file at path in a special in-terminal Markdown viewer. This allows the developer to navigate around a Markdown document without leaving the terminal.
text -> Prints a text file to the terminal.

docs:
  - name: testing
    description: Docs around testing
    kind: markdown # [markdown|url|text]
    path: docs/testing.md

docs

Templates

Templates allow you to specify templated commands that can be reused by tasks. Values are injected positionally. These are intended to facilitate code reuse and uniformity across structurally similar commands.

templates:
  - name: docker_build
    command: "docker build {path} -t rox:{image_tag}"
    symbols: ["{path}", "{image_tag}"]

Tasks

Tasks are discrete units of execution. They're intended to be single shell commands that can then be composed via pipelines. They are also able to leverage templates by specifying one with uses and injecting values with values.

tasks:
  - name: build-prod
    description: "Build the application dockerfile"
    uses: docker_build
    values: [".", "latest"]
    
  - name: "watch-run"
    description: "Run the application, restarting on file changes"
    command: "cargo watch -c -x run"

task

Pipelines

Pipelines are the canonical way to chain together multiple tasks into a single unit of execution. Note that the stages object expects a list of lists, which we'll expand upon below.

pipelines: 
  - name: example-pipeline
    description: Composes a few tasks
    stages:
      - ["task-a"]
      - ["task-b", "task-c"]

To make execution more efficient, Pipelines support a simple scheduling syntax that allows tasks within the same stage to be executed in parallel. This gives user more fine-grained control over how multiple tasks are executed while still keeping the syntax relatively lightweight.

Note: Parallel execution is not used by default, and requires using the --parallel or -p flag on invocation.

The stages field expects a list of lists to facilitate this. Each stage is like a small pipeline in and of itself, and each stage's tasks must all finish executing before work starts on the next stage.

In the following example, the parallel execution pattern would look like this:

Tasks a is executed
Tasks b and c are executed, potentially in parallel
Tasks e and d are executed, potentially in parallel.
Finally, task f is executed.

pipelines: 
  - name: example-pipeline
    description: Composes a few tasks
    stages:
      - ["task-a"]
      - ["task-b", "task-c"]
      - ["task-e", "task-d"]
      - ["task-f"]

Logs

There isn't a specific roxfile section for it, but the logs subcommand is very useful for quickly viewing recent logs.

logs

Putting it all together

Now that we've seen each individual piece of the Rox puzzle, we can put them all together into a full roxfile. See the example roxfile.yml in this repo for a working example!

Installing the rox executable

Adding rox library as a dependency

Installing the `rox` executable

Adding `rox` library as a dependency