---
title: "vx CLI"
description: "The one Virdx command line tool, and how to install it."
image: "https://docs.virdx.dev/img/virdx-social-card.png"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.virdx.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# vx CLI

`vx` bundles our command line needs: today minipages and nanochallenges.

## Install

```sh
pixi global install -c https://quantco.jfrog.io/artifactory/api/conda/virdx -c conda-forge vx
vx --help
```

Update with `pixi global update vx`.

## Commands

| Command | Does | Needs |
| --- | --- | --- |
| `vx minipage deploy` | publish a folder as a [minipage](/dashboard/minipages/) | `VXDATA_TOKEN` |
| `vx challenge list` / `describe` / `submit` | [nanochallenge](/nanochallenge/) submissions | cluster kubeconfig |

`vx <command> --help` shows every option.

## Adding a command

Other packages plug in without depending on `vx`: expose a `typer.Typer` under the
`vx.commands` entry point group, and its name becomes the subcommand.

```toml
[project.entry-points."vx.commands"]
s3 = "vxs3.cli:app"   # -> vx s3 ...
```

Source: https://docs.virdx.dev/vx/index.mdx