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.11

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.11
File Size Uploaded
yapit-0.3.11.tar.gz 9.6 kB Details

Built distribution (wheel)

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

Total release size: 20.3 kB

Release files / yapit-0.3.11.tar.gz

Download URL yapit-0.3.11.tar.gz
Size 9.6 kB
Tags Source
SHA-256 checksum
How to use checksums
f6de26d1d2cd8c28cc43638c1900f4bc30c743ec4903a0366d1de24ae13bd182
BLAKE2b-256 checksum
How to use checksums
262bc7bfac8c623af91af553c226de5fe0a91bfbdb3dd2daca6b2fd17ce497e4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.12.3 {"installer":{"name":"uv","version":"0.12.3","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.11-py3-none-any.whl

Download URL yapit-0.3.11-py3-none-any.whl
Size 10.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2a12e105bc20d44f89cf2db3bbcc9cbdd646cb2b8be1d949a7749168259d2c25
BLAKE2b-256 checksum
How to use checksums
9144e5663411ab3ccc01762909d876eae86fa841a0d2fd2c2130cd47de58ee60
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.12.3 {"installer":{"name":"uv","version":"0.12.3","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

This release

0.3.11 This release

2 release files

0.3.10

2 release files

0.3.9

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