Installation¶
The highdra CLI is developed and released as a Python package. As such, it can be installed via pip, among other package managers.
We will not be using pip, though. Instead, we will manage the highdra CLI installation with uv.
Note
You can choose to install the highdra CLI in any way you like. The only method supported (and documented here) is using uv, though. If you have reasons to use a different method, you likely know what you're doing anyway.
The highdra CLI is not available on PyPI, so we will need to install it from GitHub directly.
Prerequisites¶
There are only two prerequisites for installing the highdra CLI:
You won't even need to manually install Python, uv can handle that for you.
uv¶
Open a PowerShell terminal and run the following command:
powershell -ExecutionPolicy ByPass `
-c "irm https://astral.sh/uv/install.ps1 | iex"
Tip
You can open a terminal from the Windows Explorer by right-clicking on a folder and selecting "Open in Terminal".
Run the following command in a terminal of your choice:
curl -LsSf https://astral.sh/uv/install.sh | sh
For more information and alternative methods to install uv, see uv's fantastic documentation.
gh¶
As the highdra CLI tool is not available publicly, we need to authenticate with GitHub to be able to install it. Open the GitHub CLI page in your browser and follow the installation instructions for your operating system.
Open a terminal and run gh auth login.
For each of the three questions, select the default option:
- Where do you use GitHub? - GitHub.com
- What is your preferred protocol for Git operations on this host? - HTTPS
- How would you like to authenticate GitHub CLI? - Login with a web browser
PS C:\Users\lasse> gh auth login
? Where do you use GitHub? GitHub.com
? What is your preferred protocol for Git operations on this host? HTTPS
? How would you like to authenticate GitHub CLI? Login with a web browser
! First copy your one-time code: ABCD-1234
Press Enter to open https://github.com/login/device in your browser...
✓ Authentication complete.
- gh config set -h github.com git_protocol https
✓ Configured git protocol
✓ Logged in as Finwood
Once you have authenticated with GitHub, you can proceed to install the highdra CLI.
Tip
You can check if you are authenticated by running gh auth status.
highdra CLI¶
We will install the highdra command as a uv Tool, which will make it available anywhere on your system.
Run the following commands in a PowerShell terminal:
uv tool install `
--with-executables-from cyphal-device-library `
--from git+https://github.com/starcopter/highdra-cli.git@latest `
highdra
cyphal install
Run the following commands in a terminal of your choice:
uv tool install \
--with-executables-from cyphal-device-library \
--from git+https://github.com/starcopter/highdra-cli.git@latest \
highdra
cyphal install
Important
Prior to v0.2, the highdra CLI was installed from the repository's default branch.
This has changed in v0.2 and v0.3, which is why you now need the @latest part at the end of the package URL.
If you are upgrading from an older version, you will need to first uninstall your existing installation and then follow the installation instructions again.
The second step, cyphal install, is required to download and compile the necessary Cyphal data types.
Checking¶
After installing the highdra CLI, you can check if it is available by running highdra --help:
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.
[...]
lasse@sirius:~$ highdra --help
Usage: highdra [OPTIONS] COMMAND [ARGS]...
highdra CLI v0.1.0.
See https://highdra-cli.pages.dev/ for more information.
[...]
Uninstall¶
To uninstall the highdra CLI, run the following command:
Run the following commands in a PowerShell terminal:
uv tool uninstall highdra
Run the following commands in a terminal of your choice:
uv tool uninstall highdra