# cargo-vex-rt

Cargo command line tool to build and upload [vex-rt](https://crates.io/crates/vex-rt) projects to VEX V5 brains.

run `cargo vex-rt` in your crate's root to upload the project, or use `cargo vex-rt --help` for configuration information.

## Requirements

This tool requires [cargo-binutils](https://crates.io/crates/cargo-binutils) and [pros-cli](https://pypi.org/project/pros-cli/) to run. These can be installed by running `cargo install cargo-binutils` and `pip install pros-cli`.

## Installation

To install the tool, run `cargo install cargo-vex-rt`.

## Usage

By default, `cargo vex-rt` builds and uploads the crates's default binary to slot 1 of the connected V5 brain. Optional arguments are available to customize which target is uploaded and how it appears on the V5.

The `cargo` prefix is optional and the shorthand `vex-rt` can be used to provide the same functionality.

| Short | Long | Description |
|---|---|---|
| `-s N` | `--slot N` | Specify which slot on the Vex brain to upload to, from 1 to 8 (Default 1). |
| `-n NAME` | `--name NAME` | Set the program display name on the v5. Defaults to the name of the target binary. |
| `-d` | `--debug` | Compile with debugging information and disable optimizations. Uploading without this flag builds in release mode. |
| `-r` | `--run` | Start the program immediately after uploading |
| `-t` | `--terminal` | Open a serial terminal after uploading (`pros t`) |
| | `--bin NAME` or `--example NAME` | Specify a non-default binary target or example module to upload |

The command can additionally pass through crate feature arguments (`--features`. `--all-features`, & `--no-default-features`). This information can be viewed at any time by running `cargo vex-rt --help`.