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 --url http://localhost:8000
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 --url https://app.ventilatepro.com --token vpcli_...
  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 --url https://ventilatepro.com --token-prompt-visible

or pipe the token through stdin:

printf '%s' "$VPCLI_TOKEN" | ventilatepro auth login --url https://ventilatepro.com --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.0.tar.gz (27.6 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.0-py3-none-any.whl (28.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ventilatepro_cli-0.3.0.tar.gz
  • Upload date:
  • Size: 27.6 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.0.tar.gz
Algorithm Hash digest
SHA256 8259dcbf242d55c0eb1113dc411d3a8db903d85e1b228c2e959ca17d56646b73
MD5 a6b084a12ed2ff53ba0f2ddb2b8744cf
BLAKE2b-256 5e7bc14fd2153e0fe3b3b62757b159e2f4845f3d4e044b726f4dce62c372753d

See more details on using hashes here.

Provenance

The following attestation bundles were made for ventilatepro_cli-0.3.0.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.0-py3-none-any.whl.

File metadata

File hashes

Hashes for ventilatepro_cli-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2556e9153ce775d9a4e66aaea38c8f5e8bf78a6d938aeeb0893c82c82d2b13ea
MD5 d877e7202a73111e5ff11a5c674724d5
BLAKE2b-256 eee16139ba8b0b2e32174a2697a89f8a40aac67fe0704dbd6690285480e5606f

See more details on using hashes here.

Provenance

The following attestation bundles were made for ventilatepro_cli-0.3.0-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