Table of Contents

Huddly CLI tool

Getting Started

You can either download a precompiled binary or install the Huddly CLI as a .NET tool. For .NET developers, installing it as a tool is usually the preferred option.

linux-arm64: https://huddlyreleaseserver.azurewebsites.net/download/ga/huddly-cli-linux-arm64
linux-x64: https://huddlyreleaseserver.azurewebsites.net/download/ga/huddly-cli-linux-x64
osx-arm64: https://huddlyreleaseserver.azurewebsites.net/download/ga/huddly-cli-osx-arm64
osx-x64: https://huddlyreleaseserver.azurewebsites.net/download/ga/huddly-cli-osx-x64
win-arm64: https://huddlyreleaseserver.azurewebsites.net/download/ga/huddly-cli-win-arm64
win-x64: https://huddlyreleaseserver.azurewebsites.net/download/ga/huddly-cli-win-x64

Install as a dotnet tool

The Huddly CLI tool is built and distributed using the same version of the .NET SDK packages it was developed with. If you experience a bug in your .NET SDK integration and suspect it originates from the SDK, you can confirm this by attempting to reproduce the issue using the Huddly CLI tool (assuming the CLI supports the same functionality).

Updating (all platforms)

After successful installation, you can update the Huddly CLI tool using: dotnet tool update -g huddly

To install a specific version run:

dotnet tool uninstall -g huddly
dotnet tool install -g huddly --version 2.27.0

linux Install

sudo apt update
sudo apt install -y dotnet-sdk-8.0
sudo apt-get install libusb-1.0-0-dev
dotnet tool install -g huddly

macOS Install

# Install .NET8
brew install --cask dotnet-sdk@8
# or
brew install dotnet-sdk@8

# Set environment variables
export DOTNET_ROOT="$(brew --prefix)/opt/dotnet-sdk@8/libexec"
export PATH="$DOTNET_ROOT:$PATH"
export DYLD_LIBRARY_PATH="$(brew --prefix)/opt/libusb/lib:$DYLD_LIBRARY_PATH"

# Persist environment variables
echo 'export DOTNET_ROOT="$(brew --prefix)/opt/dotnet-sdk@8/libexec"' >> ~/.zprofile
echo 'export PATH="$DOTNET_ROOT:$PATH"' >> ~/.zprofile
source ~/.zprofile
# or
echo 'export DOTNET_ROOT="$(brew --prefix)/opt/dotnet-sdk@8/libexec"' >> ~/.bash_profile
echo 'export PATH="$DOTNET_ROOT:$PATH"' >> ~/.bash_profile
source ~/.bash_profile

# Install the Huddly CLI tool
dotnet tool install -g huddly

Windows Install

winget install Microsoft.DotNet.SDK.8
dotnet tool install -g huddly

Sample Commands

huddly device list List all connected Huddly IP and USB devices
huddly device log --file desired_file_name.log Save a single device log to specified file path
huddly device log --multiple --output ~/logs Save logs for all connected devices to ~/logs directory
huddly device log -s F00BA1337 --output . Save log for device with serial number F00BA1337 to current directory
huddly device update --multiple --download rc Update all connected IP and USB devices using the latest software from the rc channel
huddly device update --download stable 1.6.21-156906 Update connected device using a download of stable version 1.6.21-156906
huddly software download L1 --type IP Downloads L1 latest stable CPIO version to the current directory
huddly software download L1 --version "1.5.34*" --output ~/fw Downloads latest version for the L1 matching 1.5.34* to ~/fw
huddly software download IQ --version rc Downloads IQ latest release candidate version to the current directory

Help

huddly --help or huddly -? Prints generic help text for the available commands
huddly --help-all or huddly -?? Prints help text including extended options

huddly device --help
Description:
  Lets you huddle with Huddly devices ;)

Usage:
  huddly device [command] [options]

Options:
  -v, --verbose    Enable console logging at the verbose level
  -??, --help-all  Show all help and usage information, including extended options
  -?, -h, --help   Show help and usage information

Commands:
  list           List connected devices
  log            Get or erase device logs
  reboot         Reboot one or more connected devices
  update <path>  Update device software
                 [path: optional local file path; or use '--download' option]
  config <key>   Get or set device configuration
                 [key: framing|brightness|saturation|pan|tilt|zoom|...]
  info <key>     Get device information
                 [key: uptime|device-time|version-core|version-full]
  feature        List or update device feature options
  stream <type>  Subscribe to and stream device events
                 [type: FramingZoneDetection|PersonDetectionContinuous|...]

huddly device [command] --help Prints help for the specified command, e.g.

huddly device update --help
Description:
  Update device software

Usage:
  huddly device update [<path>] [options]

Arguments:
  <path>  Software file path []

Options:
  -d, --download <channel> <version?>  Download software update from the Huddly Release Server
                                       Channel (default=stable): 'wu', 'partner', 'ga', 'stable', 'rc' or 'beta'
                                       Version (optional): <major>.<minor>.<patch>-<prerelease>
  -s, --serial <serial>                Device serial number
  -m, --multiple                       Perform operation on all connected devices
  -v, --verbose                        Enable console logging at the verbose level
  -??, --help-all                      Show all help and usage information, including extended options
  -?, -h, --help                       Show help and usage information
Edit this page