Skip to main content

yapit

CLI for yapit.md — fetch clean markdown from URLs, files, and documents.

Install

uv tool install yapit

Usage

# Create document from URL, print markdown
yapit https://example.com/article
yapit https://arxiv.org/abs/2301.00001

# Local files
yapit paper.pdf
yapit notes.md

# With AI transformation (TTS annotations, spoken readings for math, figure extraction, noise filtering)
yapit paper.pdf --ai

# Fetch existing document
yapit https://yapit.md/listen/<doc-id>
yapit <doc-id> --annotated

# Save to directory with images
yapit <doc-id> -o .

# Stdin
echo "hello world" | yapit -

Auth

Creating documents or accessing private docs requires a yapit.md account:

export YAPIT_EMAIL=you@example.com
export YAPIT_PASSWORD=...

Fetching shared documents works without auth.

Self-hosting

Point the CLI at your own instance with YAPIT_BASE_URL:

export YAPIT_BASE_URL=http://localhost:8000
yapit fetch paper.pdf

If your server runs with AUTH_ENABLED=false (the make self-host default), no credentials are needed. If auth is enabled on your instance, set YAPIT_EMAIL / YAPIT_PASSWORD as above.

Save to directory (-o)

-o <dir> saves markdown, TTS annotations, and images:

<dir>/<slug>/
  <slug>.md       # clean markdown, image paths rewritten to relative
  TTS.md          # annotated version (yap-speak, yap-show tags)
  <slug>-<N>.png  # images renamed sequentially

Errors if the output directory already exists.

Release files for yapit 0.3.9

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for yapit 0.3.9
File Size Uploaded
yapit-0.3.9.tar.gz 9.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for yapit 0.3.9
File Interpreter ABI Platform
yapit-0.3.9-py3-none-any.whl Python 3 none any Details

Total release size: 19.9 kB

Release files / yapit-0.3.9.tar.gz

Download URL yapit-0.3.9.tar.gz
Size 9.4 kB
Tags Source
SHA-256 checksum
How to use checksums
378863f324bfe7f7bc3a3e9bd44151be78e2da8c737fa46f9dbf3b5236632339
BLAKE2b-256 checksum
How to use checksums
4901db4cadd30935bc23052baea5816ccfa7190aa8bf82ee64525e93ff22b9e3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.11.17 {"installer":{"name":"uv","version":"0.11.17","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / yapit-0.3.9-py3-none-any.whl

Download URL yapit-0.3.9-py3-none-any.whl
Size 10.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9c62bb5337871c381e24c6eaf98d7d638ad93842bc1632ac9b0dcf880e3d8efa
BLAKE2b-256 checksum
How to use checksums
738e6f1402b7ce241607688ce11cefaa5e32e19ed4805cff881419901058a85c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.11.17 {"installer":{"name":"uv","version":"0.11.17","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release history Release notifications | RSS feed

0.3.11

2 release files

0.3.10

2 release files

This release

0.3.9 This release

2 release files

0.3.8

2 release files

0.3.7

2 release files

0.3.6

2 release files

0.3.5

2 release files

0.3.4

2 release files

0.3.3

2 release files

0.3.2

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.5

2 release files

0.2.4

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page