Metadata-Version: 2.4
Name: ventilatepro-cli
Version: 0.3.1
Summary: VentilatePro CLI
Project-URL: Homepage, https://ventilatepro.com/exam/cli/
Project-URL: Documentation, https://ventilatepro.com/exam/cli/
Project-URL: Support, https://ventilatepro.com/exam/support/
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: typer>=0.16.0
Requires-Dist: requests>=2.32.0
Requires-Dist: keyring>=25.6.0
Requires-Dist: platformdirs>=4.3.0
Requires-Dist: mcp>=1.23.0

# 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:

```bash
pipx install ventilatepro-cli
```

Upgrade an existing install:

```bash
pipx upgrade ventilatepro-cli
```

Local development install:

```bash
cd ventilatepro-cli
pip install -e .
```

## Commands

```bash
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:

```bash
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.

3. Confirm the local setup:

```bash
ventilatepro mcp doctor
```

4. Add the stdio server to Codex:

```bash
codex mcp add ventilatepro -- ventilatepro-mcp
```

For JSON-based MCP clients, use:

```json
{
  "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:

```bash
ventilatepro auth login --token-prompt-visible
```

or pipe the token through stdin:

```bash
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/commands.md), [docs/auth.md](./docs/auth.md), [docs/api.md](./docs/api.md), and [docs/releasing.md](./docs/releasing.md) in this repo.
