- macOS, Linux or Windows
- git client
- curl command line utility
- kotlin
- java SDK with
JAVA_HOME
environment variable properly set up - maven (previously installed and available from the command line)
Note to Windows users
Use a git bash terminal for running the commands below. Windows CMD and PowerShell are not supported
Reminder: the command below should be run from examples/kotlin-maven directory
From the built-in terminal:
./tcrw
Here are the main shortcuts available once TCR utility is running:
Shortcut | Description |
---|---|
o / O |
Open in browser (with web subcommand only) |
d / D |
Enter driver role |
n / N |
Enter navigator role |
t / T |
Query timer status |
p / P |
Toggle on/off git auto-push |
l / L |
Pull from remote |
s / S |
Push to remote |
a / A |
Abort current command (when in driver role) |
q / Q |
Quit current role / Quit TCR |
? |
List available options |
Refer to tcr.md page for additional details and explanations about TCR available subcommands and options