Metadata-Version: 2.4
Name: ventilatepro-cli
Version: 0.1.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.9
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

# 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 --url http://localhost:8000
ventilatepro projects list
ventilatepro notes create --project 1 --body "Captured from terminal"
ventilatepro notes sync
```

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

```bash
ventilatepro auth login --url https://ventilatepro.com --token-prompt-visible
```

or pipe the token through stdin:

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