Skip to main content

CLI

The Foxglove CLI tool helps you import, export, and interact with your data from the command line.

Installation​

Download the latest release from your command line.

OSarchitecturecommand
linux
amd64curl -L https://github.com/foxglove/foxglove-cli/releases/latest/download/foxglove-linux-amd64 -o foxglove && chmod +x foxglove
arm64curl -L https://github.com/foxglove/foxglove-cli/releases/latest/download/foxglove-linux-arm64 -o foxglove && chmod +x foxglove
macos
anyUsing homebrew: brew install foxglove-cli
amd64curl -L https://github.com/foxglove/foxglove-cli/releases/latest/download/foxglove-macos-amd64 -o foxglove && chmod +x foxglove
arm64curl -L https://github.com/foxglove/foxglove-cli/releases/latest/download/foxglove-macos-arm64 -o foxglove && chmod +x foxglove
windows
amd64curl -L https://github.com/foxglove/foxglove-cli/releases/latest/download/foxglove-windows-amd64.exe -o foxglove.exe
arm64curl -L https://github.com/foxglove/foxglove-cli/releases/latest/download/foxglove-windows-arm64.exe -o foxglove.exe

After downloading the file, you may want to move it to a location in your system's PATH to make it more easily executable.

To install a specific release, see the releases page.

Getting started​

Before interacting with your data, you must first authenticate with your Foxglove account:

foxglove auth login

For a list of all available CLI commands:

foxglove -h

Enable shell autocompletion for subcommands and parameters (bash, zsh, fish, and PowerShell are supported):

foxglove completion <shell> -h

Actions​

CreateListDelete
Projectsfoxglove projects list
Devicesfoxglove devices add --name "my device" --project-id prj_abcd1234foxglove devices listfoxglove devices delete --name "my device"
Recordingsfoxglove data import ~/data/bags/gps.bag --device-id dev_drpLqjBZYUzus3gvfoxglove recordings list
Eventsfoxglove events add --device-id dev_flm75pLkfzUBX2DH --timestamp 2022-01-01T12:00:00Z --duration-nanos 0 --metadata 'someKey:someValue'foxglove events list
Extensionsfoxglove extensions publish ./my-extension.1.0.0.foxefoxglove extensions listfoxglove extensions unpublish ext_BsGXKGsZ9c4WQF1

Visualizing data​

The Foxglove CLI tool cannot directly open data in the Foxglove app, but the app binary can accept data source parameters when opened via the command line.