Validibot CLI
Command-line interface for the Validibot data validation platform
Installation • Quick Start • Commands • CI/CD Integration • Documentation
Part of the Validibot Project
| Repository | Description |
|---|---|
| validibot | Core platform — web UI, REST API, workflow engine |
| validibot-cli (this repo) | Command-line interface |
| validibot-validator-backends | Advanced validator backend containers (EnergyPlus™, FMI) |
| validibot-shared | Shared Pydantic models for data interchange |
What is Validibot CLI?
Validibot CLI provides command-line access to your Validibot server for automated data validation. Use it to:
- Run validations from terminals, scripts, or CI/CD pipelines
- Integrate validation into your development workflow
- Automate quality checks for building energy models, simulations, and structured data
The CLI communicates with your Validibot server's REST API, so you need a running Validibot instance to use it.
Features
- Self-hosted support — connect to your own Validibot server
- Workflow support — reference workflows by ID or human-readable slug
- Organization filtering — disambiguate workflows across orgs and projects
- Secure credential storage — uses system keyring (macOS Keychain, Windows Credential Manager, Linux Secret Service)
- CI/CD friendly — meaningful exit codes and JSON output for scripting
Disclaimer
Installation
# Using pip
pip install validibot-cli
# Using uv (recommended)
uv tool install validibot-cli
# Using pipx
pipx install validibot-cli
Requirements
- Python 3.10 or later
- A running Validibot server
Quick Start
1. Configure Your Server
Point the CLI at your Validibot server:
validibot config set-server https://validibot.your-company.com
2. Authenticate
Get your API key from your Validibot server's web interface (Settings → API Key), then:
validibot login
# Enter your API key when prompted (input is hidden)
Your API key is stored securely in your system keyring.
3. List Available Workflows
validibot workflows list
This displays a table of workflows you have access to, including their IDs, names, and status.
4. Run a Validation
# By workflow ID
validibot validate model.idf --workflow 123
# By workflow slug
validibot validate model.idf --workflow energyplus-schema-check
The CLI uploads your file, runs the validation workflow, and displays results when complete.
Commands
Server Configuration
validibot config set-server <url> # Set server URL (required before login)
validibot config get-server # Show current server URL
validibot config clear-server # Clear stored server URL
Authentication
validibot login # Authenticate with your API key
validibot logout # Remove stored credentials
validibot whoami # Show current user info (verifies API key)
validibot auth status # Check if authenticated (no API call)
Login flow:
- Prompts for your API key (input is hidden for security)
- Validates the key against the Validibot API
- Stores the key securely in your system keyring
- Fetches your organizations and sets a default:
- If you belong to one org, it becomes your default automatically
- If you belong to multiple orgs, you'll be prompted to select one
- Displays your account info to confirm success
Credential storage:
| Platform | Storage |
|---|---|
| macOS | Keychain |
| Windows | Credential Manager |
| Linux | Secret Service (GNOME Keyring, KWallet) |
If the system keyring is unavailable, credentials fall back to ~/.config/validibot/credentials.json with restrictive file permissions.
Workflows
validibot workflows list # List all available workflows
validibot workflows list --json # Output as JSON
validibot workflows show <workflow-id-or-slug> # Show workflow details
Validation Runs
validibot runs show <run-id> # Show run status and results
validibot runs show <run-id> --json # Output as JSON
Running Validations
Basic Usage
# Run a validation (waits for completion by default)
validibot validate model.idf -w <workflow-id-or-slug>
# Run without waiting (returns immediately with run ID)
validibot validate model.idf -w <workflow-id-or-slug> --no-wait
# Check status of a validation run
validibot runs show <run-id>
Workflow Selection
Workflows can be specified by ID (numeric) or slug (human-readable string):
# By numeric ID
validibot validate model.idf -w 123
# By slug
validibot validate model.idf -w energyplus-schema-check
When using slugs, if multiple workflows share the same slug across different organizations, you'll need to disambiguate:
# Specify organization
validibot validate model.idf -w my-workflow --org acme-corp
# Specify organization and project
validibot validate model.idf -w my-workflow --org acme-corp --project building-a
# Specify a particular version
validibot validate model.idf -w my-workflow --org acme-corp --version 2
Output Options
# Verbose output (shows individual step results)
validibot validate model.idf -w <workflow> --verbose
# JSON output (for scripting/CI)
validibot validate model.idf -w <workflow> --json
# Custom timeout (default: 600 seconds)
validibot validate model.idf -w <workflow> --timeout 300
# Name your validation run
validibot validate model.idf -w <workflow> --name "nightly-build-check"
# Attach submission metadata for rules to read (repeatable)
# Readable in workflow rules as submission.metadata.<key>
validibot validate model.idf -w <workflow> --meta deliverable=handover --meta phase=dd
# Add a short description, readable in rules as submission.short_description
validibot validate model.idf -w <workflow> --short-description "Stage 4 handover model"
Option Reference
| Option | Short | Description |
|---|---|---|
--workflow |
-w |
Workflow ID or slug (required) |
--org |
-o |
Organization slug |
--project |
-p |
Project slug for filtering |
--version |
Workflow version | |
--name |
-n |
Name for this validation run |
--meta |
Submission metadata as key=value (repeatable); readable in rules as submission.metadata.<key> |
|
--short-description |
Short description for this run; readable in rules as submission.short_description |
|
--wait/--no-wait |
Wait for completion (default: wait) | |
--timeout |
-t |
Max wait time in seconds (default: 600) |
--verbose |
-v |
Show detailed step-by-step output |
--json |
-j |
Output results as JSON |
Configuration
Server URL Resolution
The CLI determines which server to connect to in this order:
VALIDIBOT_API_URLenvironment variable- Stored server URL from
validibot config set-server - Error if neither is set
Environment Variables
| Variable | Description | Default |
|---|---|---|
VALIDIBOT_API_URL |
Server URL | — |
VALIDIBOT_TOKEN |
API key (alternative to validibot login) |
— |
VALIDIBOT_ORG |
Default organization slug | — |
VALIDIBOT_TIMEOUT |
Request timeout in seconds | 300 |
VALIDIBOT_POLL_INTERVAL |
Status polling interval in seconds | 5 |
VALIDIBOT_NO_KEYRING |
Disable keyring, use file storage | false |
VALIDIBOT_ALLOW_INSECURE_API_URL |
Allow non-HTTPS API URL (dangerous) | false |
Organization Resolution
When --org is not explicitly provided, the CLI resolves the organization in this order:
--orgflag (if provided)VALIDIBOT_ORGenvironment variable- Default org saved during
validibot login - Error with a helpful message
Exit Codes
The validate command returns meaningful exit codes for CI/CD integration:
| Code | Meaning |
|---|---|
0 |
Validation passed |
1 |
Validation failed (FAIL) or CLI/API error |
2 |
Validation error (ERROR/TIMED_OUT/CANCELED) |
3 |
Timed out waiting for completion (run still in progress) |
130 |
Interrupted (Ctrl+C) |
CI/CD Integration
GitHub Actions
name: Validate Building Model
on: [push, pull_request]
jobs:
validate:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.12"
- name: Install Validibot CLI
run: pip install validibot-cli
- name: Validate model
env:
VALIDIBOT_API_URL: ${{ vars.VALIDIBOT_API_URL }}
VALIDIBOT_TOKEN: ${{ secrets.VALIDIBOT_TOKEN }}
run: validibot validate model.idf -w ${{ vars.WORKFLOW_ID }}
GitLab CI
validate:
image: python:3.12
script:
- pip install validibot-cli
- validibot validate model.idf -w $WORKFLOW_ID
variables:
VALIDIBOT_API_URL: $VALIDIBOT_API_URL
VALIDIBOT_TOKEN: $VALIDIBOT_TOKEN
Azure Pipelines
- task: UsePythonVersion@0
inputs:
versionSpec: "3.12"
- script: |
pip install validibot-cli
validibot validate model.idf -w $(WORKFLOW_ID)
env:
VALIDIBOT_API_URL: $(VALIDIBOT_API_URL)
VALIDIBOT_TOKEN: $(VALIDIBOT_TOKEN)
Development
# Clone the repository
git clone https://github.com/mcquilleninteractive/validibot-cli.git
cd validibot-cli
# Install with dev dependencies
uv sync --extra dev
# Run the CLI locally
uv run validibot --help
# Run tests
uv run pytest
# Run tests with coverage
uv run pytest --cov=validibot_cli
# Lint and format
uv run ruff check .
uv run ruff format .
# Type checking
uv run mypy src/
License
MIT License — see LICENSE for details.
Metadata
Release files for validibot-cli 0.3.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| validibot_cli-0.3.2.tar.gz | 111.4 kB | With provenance | Details for validibot_cli-0.3.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| validibot_cli-0.3.2-py3-none-any.whl | Python 3 | none | any | Details for validibot_cli-0.3.2-py3-none-any.whl |
Total release size: 147.2 kB
Release files / validibot_cli-0.3.2.tar.gz
| Download URL | validibot_cli-0.3.2.tar.gz |
|---|---|
| Size | 111.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e72f91923f7f3a33b14e1e8b49ab39e378df7c78a8379fd7315659e1383efd67
|
|
BLAKE2b-256 checksum How to use checksums |
03389ae8391e8ad8accc047ef5026a21448ef38be202f5ba5858a6bfbe3431bb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 29, 2026.
Transparency logRelease files / validibot_cli-0.3.2-py3-none-any.whl
| Download URL | validibot_cli-0.3.2-py3-none-any.whl |
|---|---|
| Size | 35.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
70fc1f88b7b7e93a1f1f613bd43b307bb39b164c422c5059bb829ebdb517e1bd
|
|
BLAKE2b-256 checksum How to use checksums |
29b54c98f4e50977b864ee351f1c5574556b52317fa37fb8a5dae5a826b6acf1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 29, 2026.
Transparency logSecurity for validibot-cli 0.3.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for validibot_cli-0.3.2.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 29, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.