Metadata-Version: 2.4
Name: mdview-cli
Version: 0.1.0
Summary: Iterate on Markdown and verify every revision with mdview.io
License-Expression: MIT
Project-URL: Homepage, https://mdview.io
Project-URL: Repository, https://github.com/gogainda/mdview-cli
Project-URL: Issues, https://github.com/gogainda/mdview-cli/issues
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: click>=8.1
Requires-Dist: httpx>=0.27
Requires-Dist: platformdirs>=4.0
Provides-Extra: test
Requires-Dist: pytest>=8.0; extra == "test"
Dynamic: license-file

# mdv

`mdv` opens Markdown in mdview.io and can keep an evolving file attached to one
stable document while checking every revision in the PDF renderer.

## Quick start — no token required

```bash
uv tool install mdview-cli
mdv architecture.md
```

`mdv FILE.md` is shorthand for `mdv preview FILE.md`: it publishes the file
anonymously and opens a temporary mdview page you can share (30-day expiry,
2 MB limit). No account, token, or configuration required.

`open` renders a local file in the browser without uploading anything at all:

```bash
mdv open architecture.md
```

## Verify every revision

Saved-document commands require a mdview.io CLI token because they update your
documents between runs. Configure it once, then sync the same file after every
edit:

```bash
mdv keys set
mdv sync architecture.md
```

Edit the file and run `mdv sync architecture.md` again. The share URL stays the
same. Exit status `0` means every Mermaid diagram rendered; status `1` means the
document needs attention.

```bash
mdv fix architecture.md
mdv export architecture.md
```

`open` and `preview` are token-free. `sync`, `verify`, `fix`, `export`, and `list` use a token
to access Saved documents. In CI, set `MDVIEW_TOKEN` instead of storing it.
`MDVIEW_BASE_URL` overrides the service URL for development.
