Skip to main content

llms-ink

Turn any public link — a site, docs section, page, GitHub repo, PDF or video — into llms.txt or llms-full.txt, from Python. A client for llms.ink with LangChain and LlamaIndex loaders. No required dependencies.

pip install llms-ink

Use

from llms_ink import Client

ink = Client()
index = ink.llms("llmstxt.org")                         # llms.txt: an index of links
docs = ink.llms("docs.astro.build/en/guides/", mode="full")  # llms-full.txt: the content

print(docs.title, docs.kind, docs.tokens)
print(docs.text)

llms() returns a Result: url, kind (site, section, page, repo, document, video), source (native = published by the site, generated = made by llms.ink), mode, title, text, tokens, pages, model, cached, generated_at, and media for videos (duration, downloads, transcript segments). fresh=True skips the cache and rebuilds.

Check a site's published llms.txt:

report = ink.check("llmstxt.org")
print(report.found, report.summary.errors, [i.message for i in report.issues])

API key (optional)

Without a key you share the free anonymous limits (10 requests/minute, 60 new links a day per IP; cached links are free). A key gets its own daily quota:

export LLMS_INK_KEY=lk_...

or Client(key="lk_..."). It is sent as Authorization: Bearer. A bad key raises InvalidKey; it never falls back to anonymous. Ask for a key.

Errors

from llms_ink import Client, LlmsInkError, QuotaExceeded, RateLimited

try:
    Client().llms("example.com")
except (RateLimited, QuotaExceeded) as err:
    print(f"wait {err.retry_after}s")
except LlmsInkError as err:
    print(err.status, err.code, err.detail)

LlmsInkError carries the API's status, code (see the error table), detail and errors. InvalidKey, RateLimited and QuotaExceeded are subclasses.

LangChain

pip install 'llms-ink[langchain]'
from llms_ink.langchain import LlmsInkLoader

docs = LlmsInkLoader(["llmstxt.org", "github.com/AnswerDotAI/llms-txt"], mode="full").load()
docs[0].metadata  # {'url', 'title', 'kind', 'source', 'mode', 'tokens', 'generated_at'}

LlamaIndex

pip install 'llms-ink[llama-index]'
from llama_index.core import VectorStoreIndex
from llms_ink.llama_index import LlmsInkReader

docs = LlmsInkReader(mode="full").load_data(["docs.astro.build/en/guides/"])
index = VectorStoreIndex.from_documents(docs)

Command line

python -m llms_ink llmstxt.org            # llms.txt
python -m llms_ink llmstxt.org --full     # llms-full.txt
python -m llms_ink llmstxt.org --json     # the whole result

MCP server (stdio)

For agents that launch local MCP servers, such as Hermes Agent. It forwards every message to the remote server https://llms.ink/mcp and sends LLMS_INK_KEY, when set, as Authorization: Bearer.

uvx --from llms-ink llms-ink-mcp     # with uv, nothing to install
python -m llms_ink mcp               # after pip install llms-ink

Hermes Agent, in ~/.hermes/config.yaml:

mcp_servers:
  llms-ink:
    command: uvx
    args: [--from, llms-ink, llms-ink-mcp]
    env:
      LLMS_INK_KEY: ${LLMS_INK_KEY}  # only with LLMS_INK_KEY set in ~/.hermes/.env

Other clients use the same command in their mcpServers config. A rejected key makes every request fail with the API's message; it never falls back to anonymous. Clients that speak Streamable HTTP can connect to https://llms.ink/mcp directly.

Development

python3 -m venv .venv && .venv/bin/pip install -e '.[langchain,llama-index]' pytest
.venv/bin/pytest                # against a local stub server
.venv/bin/pytest -m live        # one real call to https://llms.ink

LLMS_INK_API points the client at another API base URL.

MIT licensed.

Metadata

Release files for llms-ink 0.2.0

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

Source distribution (sdist)

Source distribution for llms-ink 0.2.0
File Size Uploaded Provenance Actions
llms_ink-0.2.0.tar.gz 16.8 kB Without provenance Details for llms_ink-0.2.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for llms-ink 0.2.0
File Interpreter ABI Platform Actions
llms_ink-0.2.0-py3-none-any.whl Python 3 none any Details for llms_ink-0.2.0-py3-none-any.whl

Total release size: 32.0 kB

Release files / llms_ink-0.2.0.tar.gz

Download URL llms_ink-0.2.0.tar.gz
Size 16.8 kB
Tags Source
SHA-256 checksum
How to use checksums
f2e80029d94cffba99660f6a17eeed2b19b79576560c27f9667c98987bd25c10
BLAKE2b-256 checksum
How to use checksums
5fbe656ca492449f96ce786e5e3af18e6eda99e49bae7dfc3f503d8be3c0c67c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.5

Release files / llms_ink-0.2.0-py3-none-any.whl

Download URL llms_ink-0.2.0-py3-none-any.whl
Size 15.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7edc7f23745c8ff64a88e3ef71a9899bd06ff8bc6c569e718f98d4d1c0e7b28d
BLAKE2b-256 checksum
How to use checksums
1001bef479469f4f448b781c3783a1bd35708cd2541054a3a3f989ec28cd1b3b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.5

Security for llms-ink 0.2.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

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