Getting Help¶

Command Line Help¶

The highdra CLI has a built-in help that is accessible from the command line:

PS C:\Users\lasse> highdra --help

 Usage: highdra [OPTIONS] COMMAND [ARGS]...

 highdra CLI v0.1.0.

 See https://highdra-cli.pages.dev/ for more information.

╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --version                              Display the version and exit.         │
│ --verbose             -v      INTEGER  Increase console log verbosity. Can   │
│                                        be specified multiple times.          │
│                                        [default: 0]                          │
│ --install-completion                   Install completion for the current    │
│                                        shell.                                │
│ --show-completion                      Show completion for the current       │
│                                        shell, to copy it or customize the    │
│                                        installation.                         │
│ --help                                 Show this message and exit.           │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Subcommands ────────────────────────────────────────────────────────────────╮
│ arm       Arm checkout and maintenance.                                      │
│ body      Body checkout and maintenance.                                     │
│ battery   Battery checkout and maintenance.                                  │
╰──────────────────────────────────────────────────────────────────────────────╯

For each command, that can be accessed by running highdra <command> --help:

PS C:\Users\lasse> highdra arm checkout --help

 Usage: highdra arm checkout [OPTIONS]

 Arm checkout.

 The checkout is performed at the end of the arm assembly process, before the
 propeller is attached. This checkout validates that both the motor and the MMB
 is working as expected.

 [...]

╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help          Show this message and exit.                                  │
╰──────────────────────────────────────────────────────────────────────────────╯

Online Documentation¶

The online documentation is available at https://highdra-cli.pages.dev/, which does not only contain information about specific commands, but also provides a general overview of the highdra CLI.

If you're stuck somewhere, please check the online documentation first. In the top right corner there is a search bar, which can be used to look for keywords and phrases.

Tip

Press s or the forward slash key / on your keyboard to quickly focus the search bar.

Log Files¶

Every invocation of the highdra CLI will create a log file in the (hidden) log directory. The location of this log directory is platform-dependent:

On Windows, the logs are stored in %LOCALAPPDATA%\starcopter\highdra-cli\Logs\.
On Linux, the logs are stored in ~/.local/state/highdra-cli/log/.

These logs may help diagnose problems you encounter.

Ask Lasse¶

If you encounter problems you cannot solve by yourself, you may open a GitHub issue or ask Lasse for help.

When asking for help

When asking for help, please provide the following information:

Where did you encounter the problem (which computer, what OS, which peripherals, etc.)
The command you ran
The error message you received
The output of highdra --version
The log file(s) from the log directory

If possible, please include a picture of the hardware setup as well.