Check a page for the structural signals observed on content AI answer engines tend to cite. Observed correlations, not guarantees.
Project description
citation-ready
Does AI cite you — and is your page even built to be cited? Check a page for the structural signals our AI Visibility Index observes on content that AI engines (ChatGPT, Perplexity, Claude, Gemini, Google AI) tend to quote and recommend.
These are observed correlations, not guarantees. A high score means your page looks like the pages that get cited — it does not promise a citation. The only way to know whether AI actually cites you is to measure it (see below).
- Zero dependencies — Python standard library only.
- Mock mode by default — runs offline against a built-in demo page.
- Honest framing — every report says these are correlations from measurement, not a ranking guarantee.
Usage
Offline demo (no network needed):
python citation_ready.py --mock
Check a live URL (also looks for /llms.txt):
python citation_ready.py --url https://example.com
Check a local HTML file:
python citation_ready.py --file page.html
Machine-readable output:
python citation_ready.py --url https://example.com --json
Example output
Strong signals — 100/100
(built-in demo page)
✓ Valid schema (JSON-LD) for AI parsing
✓ Answer-first structure (direct summary + lists/tables)
✓ Clear heading outline (one H1, descriptive H2s)
✓ Freshness signal (dateModified or a recent visible date)
✓ Consistent entity (Organization + sameAs / profiles)
✓ llms.txt present / referenced
These are observed correlations from our AI Visibility Index measurement — signals
that tend to accompany pages AI engines cite. They are not guarantees; the measured
answer for your domain comes from a teardown.
Measure the real thing: https://clearcited.com/free-teardown/
What it checks
Six structural signals, each with the honest reason it correlates with getting cited:
| Signal | Why it correlates |
|---|---|
| Valid schema (JSON-LD) | Structured data lets engines extract entities and claims cleanly. |
| Answer-first structure | Engines quote pages that state the answer early and in extractable chunks. |
| Clear heading outline | A clean outline maps to the sub-questions engines answer. |
| Freshness signal | Engines favour pages that show they are current. |
| Consistent entity | A stable, cross-linked entity is easier to attribute and trust. |
| llms.txt | An llms.txt gives agents a curated map of your canonical content. |
The score is a weighted sum of the signals present, banded into Strong / Developing / Weak. Detection is plain regex over the HTML — no headless browser, no JavaScript execution.
How this connects to real measurement
This CLI is a heuristic. It reads your page and predicts, from structure alone, whether it looks like content AI engines cite. It never sends a prompt to an engine, so it cannot tell you whether you are actually cited today.
The measured answer is a teardown: we run real buyer prompts across every major engine, several runs each, and report where you show up versus competitors — with a confidence interval, the same way every time. The signals this tool checks are drawn from what our AI Visibility Index observes on pages that earn those citations.
- How we measure: https://clearcited.com/methodology/
- Get the measured answer for your domain: https://clearcited.com/free-teardown/
Honest distinction: citation-ready is instant-but-predictive (structure only,
offline); the teardown is measured-but-async (real prompts, every engine, human QC).
License
MIT © Clear Cited
This is a free, lite tool. The full Clear Cited service measures citations across every major engine (ChatGPT, Perplexity, Claude, Gemini, Google AI Overviews), with human QC and a fix roadmap. Get a free teardown →
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file citation_ready-0.1.0.tar.gz.
File metadata
- Download URL: citation_ready-0.1.0.tar.gz
- Upload date:
- Size: 9.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6320d3ec6f1ecbd82b45b59c4ca68dc82f81b193cbb138e42290c4db69e82e15
|
|
| MD5 |
5f74a29add5e293f75f7d85fd84b3d3e
|
|
| BLAKE2b-256 |
5496a1a4bf615959046580d10d6fe4184fbb1fddc547ab7d1442163a558b6dff
|
Provenance
The following attestation bundles were made for citation_ready-0.1.0.tar.gz:
Publisher:
publish.yml on Clear-Cited/citation-ready
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
citation_ready-0.1.0.tar.gz -
Subject digest:
6320d3ec6f1ecbd82b45b59c4ca68dc82f81b193cbb138e42290c4db69e82e15 - Sigstore transparency entry: 2321933788
- Sigstore integration time:
-
Permalink:
Clear-Cited/citation-ready@95fe78315f56a06e759c3f51841dc89c18af3439 -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/Clear-Cited
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@95fe78315f56a06e759c3f51841dc89c18af3439 -
Trigger Event:
release
-
Statement type:
File details
Details for the file citation_ready-0.1.0-py3-none-any.whl.
File metadata
- Download URL: citation_ready-0.1.0-py3-none-any.whl
- Upload date:
- Size: 9.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f8a12b924c899d03d38f57faef0f93d1da558ba9beff1203dbdf0e583db2c705
|
|
| MD5 |
5d044b7fa28dafa5cb3a1bb138017331
|
|
| BLAKE2b-256 |
55358d1171c2f2c5e9ea870ce00ca5e49ad682f684ddb0529666fff5d0fb257c
|
Provenance
The following attestation bundles were made for citation_ready-0.1.0-py3-none-any.whl:
Publisher:
publish.yml on Clear-Cited/citation-ready
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
citation_ready-0.1.0-py3-none-any.whl -
Subject digest:
f8a12b924c899d03d38f57faef0f93d1da558ba9beff1203dbdf0e583db2c705 - Sigstore transparency entry: 2321933889
- Sigstore integration time:
-
Permalink:
Clear-Cited/citation-ready@95fe78315f56a06e759c3f51841dc89c18af3439 -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/Clear-Cited
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@95fe78315f56a06e759c3f51841dc89c18af3439 -
Trigger Event:
release
-
Statement type: