virtualitics-cli

Virtualitics AI Platform CLI

A command line interface for initializing, packaging, and deploying Custom Apps to the Virtualitics AI Platform (VAIP) from a local development environment.

Installation

pip install virtualitics-cli

Requires Python >= 3.14.

Quick Start

vaip config                          # Configure connection to a VAIP instance
vaip init                            # Scaffold a new VAIP app
# ... write your app code ...
vaip build --yes                     # Build a wheel
vaip deploy                          # Deploy to the VAIP instance
vaip destroy --project-name=my_app --yes  # Remove app from the instance

Usage

$ vaip [OPTIONS] COMMAND [ARGS]...

Options:

• --version
• --verbose / --no-verbose: [default: no-verbose]
• --install-completion: Install completion for the current shell.
• --show-completion: Show completion for the current shell, to copy it or customize the installation.
• --help: Show this message and exit.

Commands

vaip config

Create or update a configuration file for connecting to a VAIP instance. Requires a friendly name, host URL, API token, and username. Supports multiple named contexts.

$ vaip config [OPTIONS]

• -N, --name TEXT: Friendly name for the VAIP instance (e.g., predict-dev) [required]
• -H, --host TEXT: Backend hostname (e.g., https://predict-api-dev.virtualitics.com) [required]
• -T, --token TEXT: API token for authentication
• -U, --username TEXT: Username associated with API token

vaip use-context

Switch the active context for deployment.

$ vaip use-context CONTEXT_NAME

vaip show-context

Display the current configuration file.

$ vaip show-context

vaip delete-context

Delete a specific context from the configuration file.

$ vaip delete-context CONTEXT_NAME

vaip edit-context

Modify a specific context in the configuration file.

$ vaip edit-context CONTEXT_NAME

vaip init

Scaffold a new VAIP app structure with a pyproject.toml and package directory.

$ vaip init [OPTIONS]

• -n, --project-name TEXT: Name for the VAIP App (no spaces, numbers, or special chars besides _) [required]
• -v, --version TEXT: Version for the VAIP App [required]
• -d, --description TEXT: Description for the VAIP App [required]
• -a, --authors TEXT: Authors for the VAIP App [required]
• -l, --licenses TEXT: License for the VAIP App [required]

vaip build

Build a Python wheel file from the pyproject.toml in the current directory.

$ vaip build [OPTIONS]

• -y, --yes: Confirm the build [required]

vaip deploy

Deploy the VAIP App wheel to the configured VAIP instance.

$ vaip deploy [OPTIONS]

• -f, --file TEXT: Path to the wheel file (defaults to ./dist/*.whl)

vaip destroy

Delete a VAIP module and all its apps from the instance.

$ vaip destroy [OPTIONS]

• -n, --project-name TEXT: Project name to delete [required]
• -y, --yes: Confirm deletion [required]

vaip publish

Publish a VAIP App to other users in your organization. (Not currently implemented.)

$ vaip publish