GreenScout-CLI

The Command-line interface for FRC team 1816's scouting app, GreenScout!

Getting Started

It's expected that you at least know basic programming principles and practices. Additionally, knowing the Go Programming Language will be neccessary when contributing to this CLI.

To get started, you'll first need the Go Programming Language, Git, and VS Code (Optional).

Once you have all that installed, open up your terminal and enter this command

git clone https://github.com/TheGreenMachine/GreenScout-CLI.git

This will download the repository onto your computer and to move into it type this

cd GreenScout-CLI

Then, download all of the dependencies of this project with

go get

Then, compile the CLI by running

go build

Finally, to see the CLI's options, type

./GreenScoutCLI --help

If you are so inclined, you can move the executable into your $PATH, though I do not recommend this, as the CLI is under constant development and constantly replacing such an executable may get tiresome.

If you are using VS Code, I highly recommend installing the Golang Extension.

Additional documentation, such as a list of commands available can be found here.

Roadmap (Tasks for future devs)

• Add proper error handling

Contributers

• Tag C