Skip to main content

VentilatePro CLI

Project description

VentilatePro CLI

VentilatePro CLI is a local command-line client for authenticating to VentilatePro and creating or syncing notes through the scoped CLI API.

Install

Published releases install from PyPI:

pipx install ventilatepro-cli

Upgrade an existing install:

pipx upgrade ventilatepro-cli

Local development install:

cd ventilatepro-cli
pip install -e .

Commands

ventilatepro auth login
ventilatepro projects list
ventilatepro projects show 1
ventilatepro rooms list --project 1
ventilatepro ahus list --project 1
ventilatepro systems hierarchy --project 1
ventilatepro calc status --project 1
ventilatepro calc ahu-properties --ahu 1
ventilatepro design-day context --project 1
ventilatepro notes create --project 1 --body "Captured from terminal"
ventilatepro notes sync
ventilatepro mcp doctor
ventilatepro-mcp

ventilatepro-mcp starts the local stdio MCP server for Codex, Claude Desktop, and other MCP clients. It uses the same saved base URL and CLI token created by ventilatepro auth login.

MCP setup

  1. In the VentilatePro web app, open Account Settings and create a CLI token with the Agent Editor preset.
  2. Log in locally:
ventilatepro auth login --token vpcli_...

The production URL defaults to https://ventilatepro.com. Use --url only for local development, staging, or self-hosted VentilatePro servers.

  1. Confirm the local setup:
ventilatepro mcp doctor
  1. Add the stdio server to Codex:
codex mcp add ventilatepro -- ventilatepro-mcp

For JSON-based MCP clients, use:

{
  "mcpServers": {
    "ventilatepro": {
      "command": "ventilatepro-mcp",
      "args": []
    }
  }
}

If the client cannot find ventilatepro-mcp, run where ventilatepro-mcp on Windows or which ventilatepro-mcp on macOS/Linux and use the full path as the command.

If the hidden token prompt is awkward in your terminal, use either:

ventilatepro auth login --token-prompt-visible

or pipe the token through stdin:

printf '%s' "$VPCLI_TOKEN" | ventilatepro auth login --token-stdin

See the hosted install guide at https://ventilatepro.com/exam/cli/, plus docs/commands.md, docs/auth.md, docs/api.md, and docs/releasing.md in this repo.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ventilatepro_cli-0.3.1.tar.gz (27.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ventilatepro_cli-0.3.1-py3-none-any.whl (28.9 kB view details)

Uploaded Python 3

File details

Details for the file ventilatepro_cli-0.3.1.tar.gz.

File metadata

  • Download URL: ventilatepro_cli-0.3.1.tar.gz
  • Upload date:
  • Size: 27.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for ventilatepro_cli-0.3.1.tar.gz
Algorithm Hash digest
SHA256 256b691a933206dbc0d0c3274880ea0a709dad5ef6dc0b501fe0d099e95896b5
MD5 38e561d35c4e3a40d35422c7eea41238
BLAKE2b-256 5ea8c7cc7776800966c8798fc94b620283b3b6e6e222c0905b68277a47048af6

See more details on using hashes here.

Provenance

The following attestation bundles were made for ventilatepro_cli-0.3.1.tar.gz:

Publisher: ventilatepro-cli-release.yml on Rushikeshh-patil/PE-Exam

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ventilatepro_cli-0.3.1-py3-none-any.whl.

File metadata

File hashes

Hashes for ventilatepro_cli-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4b083173ef68b67b182b5b712dc3357d73b417e3c8464cd69117d3e1ad73cfe5
MD5 03d66634220e9baa48228280ab9389a4
BLAKE2b-256 6ee7af955e67306f267b158b290d24fff8e02e2ba6df334f562d52e339533cd2

See more details on using hashes here.

Provenance

The following attestation bundles were made for ventilatepro_cli-0.3.1-py3-none-any.whl:

Publisher: ventilatepro-cli-release.yml on Rushikeshh-patil/PE-Exam

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page