VIZO CLI

vizo is the command-line tool for downloading the datasets you are licensed for on the VIZO platform. It needs Python 3.9 or newer and nothing beyond the standard library.

Install

python3 -m venv ~/vizo-venv            # Python 3.9 or newer; the one macOS ships is fine
source ~/vizo-venv/bin/activate
pip3 install vizo

Use

export VIZO_API_KEY=vz_sk_live_...     # from the API Keys page; the only way to authenticate

vizo datasets                          # what you can download, and where to request access
vizo describe ego4d                    # its parts, and the values each filter takes, with file counts
vizo download ego4d -o ~/vizo-data/ego4d --parts clips annotations --benchmarks FHO --dry-run
vizo download ego4d -o ~/vizo-data/ego4d --parts clips annotations --benchmarks FHO -y
vizo verify ~/vizo-data/ego4d --checksum

python3 -m vizo works the same as vizo.

A command written for the official ego4d or egoexo tool runs unchanged with vizo in front. vizo ego4d and vizo egoexo take the official tools' options, with their spellings, abbreviations and defaults, and accept the AWS options and ignore them. They add four options of their own, which work only when spelled in full: --dry-run, --shard N/M, --refresh-manifest and --ignore-disk-space.

vizo ego4d -o ~/vizo-data/ego4d --datasets clips --benchmarks EM --dry-run
vizo egoexo -o ~/vizo-data/egoexo4d --parts annotations metadata -y

vizo download <dataset> takes the official tools' options, spellings and defaults as well (--parts/--datasets, --uids/--video_uids, --uid-file, --universities, --benchmarks, --splits, --views, --metadata/--no-metadata, --version/--release, --config_path, --list-datasets, --manifest, --force, --delete), with the AWS options accepted and ignored. On top: --shard N/M for splitting one download across machines, --workers, --dry-run, -y, and --refresh-manifest. A dry run fetches nothing but does create the output folder and save the manifest in it, so the real run that follows targets the same release. Files land in the official layout under -o; .vizo/ inside it holds the saved manifest, a log and a done-record per run. Rerunning the same command skips completed files; a file that was interrupted starts again from its beginning. Interrupted or failed downloads leave *.part files, which a run and verify report and never delete (shards may share a folder); delete them when no run is using the folder.

Exit codes: 0 done · 1 usage · 2 key problem · 3 not entitled · 4 incomplete/unreachable.

The full guide is on the VIZO platform, signed in, under Documentation → CLI: installation, API keys, choosing what to download, each dataset's parts and layout, verifying, large and sharded downloads, a command reference and troubleshooting. Its source is docs/ in the source repository; working on the CLI itself is covered in DEVELOPMENT.md there.