Vicohome CLI

A command-line interface tool for interacting with the Vicohome API to fetch and manage events.

Features

• List devices and view device details
• Get event history and view detailed event information
• Identify bird species from events

Installation

Quick Install (Recommended)

Install the latest version with our installation script:

curl -fsSL https://raw.githubusercontent.com/dydx/vico-cli/main/scripts/install.sh | bash

The script will automatically detect your operating system and architecture, then install the appropriate binary.

To install a specific version:

curl -fsSL https://raw.githubusercontent.com/dydx/vico-cli/main/scripts/install.sh | bash -s v1.0.0

Docker

The CLI is available as a multi-architecture Docker image (supports amd64 and arm64):

# Run the CLI with version command
docker run --rm ghcr.io/dydx/vicohome:latest version

# Run other commands
docker run --rm -e VICOHOME_EMAIL="[email protected]" -e VICOHOME_PASSWORD="your-password" ghcr.io/dydx/vicohome:latest devices list

# You can specify a version tag
docker run --rm ghcr.io/dydx/vicohome:v1.0.0 events list --format json

Download Binary Manually

Download the pre-built binary for your platform from the Releases page.

Build from Source

go build -o vico-cli main.go

Usage

Before using this tool, set your Vicohome credentials as environment variables:

export VICOHOME_EMAIL="[email protected]"
export VICOHOME_PASSWORD="your-password"

Devices

List all of your devices:

./vicohome devices list

Get details for a specific device:

./vicohome devices get [serialNumber]

Events

List recent events (defaults to last 24 hours):

./vicohome events list

List events for a specific time range:

./vicohome events list --startTime "2025-05-18 14:00:00" --endTime "2025-05-18 19:00:00"

Search for events by field within a time range:

./vicohome events search --field birdName "Northern Cardinal" --startTime "2025-05-17 00:00:00" --endTime "2025-05-18 00:00:00"
./vicohome events search --field serialNumber [serialNumber] --startTime "2025-05-18 10:00:00" --endTime "2025-05-18 15:00:00"
./vicohome events search --field deviceName "Birdies" --startTime "2025-05-18 12:00:00" --endTime "2025-05-18 18:00:00"

Get details for a specific event:

./vicohome events get [traceId]

Output Formats

All commands support both table (default) and JSON output formats:

./vicohome devices list --format json
./vicohome events get [traceId] --format json

Releasing a New Version

1. Tag the repository with a new version number:

   git tag v1.0.0
   git push origin v1.0.0

2. The GitHub Actions workflow will automatically:

   • Build binaries for multiple platforms (Windows, macOS, Linux on amd64 and arm64)
   • Create a new release with the binaries attached
   • Publish Docker images to GitHub Packages

Documentation

You can view the API documentation in several ways:

Online Documentation

The latest API documentation is automatically published to GitHub Pages:

View Vicohome CLI Documentation

Local Documentation

To generate and view documentation locally:

# Install godoc if you haven't already
go install golang.org/x/tools/cmd/godoc@latest

# Run godoc server
godoc -http=:6060

# View documentation in your browser at:
# http://localhost:6060/pkg/github.com/dydx/vico-cli/

License

MIT