Expand description
§Oratos
Website visibility intelligence for SEO, accessibility, structured metadata, and AI readiness.
Oratos audits and improves websites without owning your workflow. It works on local HTML directories, static exports, and live URLs — useful in CI/CD like Credo, Sobelow, Ruff, or Lighthouse CI.
v0.3.1 ships as a single Rust crate (CLI + library modules) with multi-ecosystem install paths that do not require Rust. API docs on docs.rs include this README.
§Install
No Rust required. Pick your environment — full details in docs/install.md.
§Linux / macOS
curl -fsSL https://raw.githubusercontent.com/latentmeta/oratos/main/scripts/install.sh | sh§Windows
Download oratos-v*-windows-x86_64.zip from Releases, extract oratos.exe, and add it to your PATH. Or use Scoop when available: scoop install oratos.
§Version managers
# mise
mise use -g github:latentmeta/oratos
# asdf
asdf plugin add oratos https://github.com/latentmeta/asdf-oratos.git
asdf install oratos latest§CI / language ecosystems
# GitHub Actions
- uses: latentmeta/oratos/.github/actions/setup-oratos@mainpip install oratos # PyPI
npm install -D oratos # npm# mix.exs — only: [:dev, :test], runtime: false
{:oratos, "~> 0.3", only: [:dev, :test], runtime: false}
# then: mix oratos.audit ./priv/static§Rust contributors
cargo install oratos
# or from a checkout:
cargo install --path crates/oratosPrebuilt binaries for Linux (x86_64/aarch64), macOS (Intel/Apple Silicon), and Windows are published on every v* tag with SHA256SUMS.
§Quick start
# Audit a static site directory
oratos audit examples/static_site
# JSON report for tooling
oratos audit examples/static_site --format json --output report.json
# CI gate: fail if overall score is below 85
oratos audit ./priv/static --fail-under 85
# Generate llms.txt draft
oratos generate llms examples/static_site
# LLM remediation prompt for a page
oratos prompt html examples/static_site/index.html§CLI
oratos audit <target> [--format console|json|markdown|html|sarif] [--output PATH] [--fail-under SCORE] [--strict] [--crawl] [--changed-only] [--config PATH]
oratos generate llms <target> [--output PATH]
oratos generate metadata <target> [--output PATH]
oratos prompt html <file-or-url> [--output PATH]
oratos prompt phoenix <file-or-url> [--output PATH]<target> may be a directory (./priv/static, ./dist), a single HTML file, or a URL (https://example.com).
URL audits: by default a URL fetches one page. Enable multi-page crawl with --crawl or [crawl] enabled = true in oratos.toml (see Configuration).
§What Oratos checks
- SEO — title, meta description, canonical, headings, Open Graph, Twitter cards, internal links
- Accessibility — alt text,
lang, landmarks, form labels, link text - Structured data — JSON-LD presence and syntax, WebPage/BreadcrumbList/ImageObject hints
- LLM readiness —
llms.txt, extractable text, summaries, image descriptions
Scores are 0–100 per category. Overall score uses weights: SEO 30%, Accessibility 25%, Structured Data 25%, LLM Readiness 20%. Penalties: error −10, warning −5, info −1 (per category).
§Phoenix / Mix
Oratos does not replace Phoenix SEO libraries — it audits rendered HTML after prerendering or static export:
# mix.exs
aliases: [
"seo.audit": ["cmd oratos audit ./priv/static --fail-under 85"],
"seo.report": ["cmd oratos audit ./priv/static --format html --output reports/oratos.html"]
]See docs/phoenix.md and docs/ci.md.
§Library
Use Oratos from Rust without shelling out to the CLI:
[dependencies]
oratos = "0.3"use oratos::{audit_pages, load_pages, LoadOptions};
#[tokio::main]
async fn main() -> anyhow::Result<()> {
let pages = load_pages("examples/static_site", &LoadOptions::default()).await?;
let report = audit_pages("examples/static_site", &pages);
println!("overall score: {:.1}", report.scores.overall);
Ok(())
}See docs/architecture.md for module layout. Upgrading from v0.2 split crates? See v0.3.0 release notes. Latest patch notes: v0.3.1.
§Documentation
- Install
- Architecture
- Configuration
- Reports — includes JSON schema
- Rule catalog
- Scoring
- CI/CD
- Phoenix workflows
- llms.txt
- Remediation prompts
- Tutorials
- Publishing to crates.io
- Roadmap
- Release notes (v0.3.1)
- pre-commit · Node/Python
§Development
cargo test
cargo clippy -- -D warnings
cargo fmt --check§License
MIT — see the LICENSE file.
Re-exports§
pub use audit::audit_pages;pub use audit::resolve_target;pub use audit::Rule;pub use core::apply_ignore_rules;pub use core::AuditConfig;pub use core::AuditReport;pub use core::AuditTarget;pub use core::Category;pub use core::CategoryScores;pub use core::ConfigError;pub use core::CrawlConfig;pub use core::Finding;pub use core::Location;pub use core::OratosConfig;pub use core::PageAudit;pub use core::PageRef;pub use core::ScoreBreakdown;pub use core::Severity;pub use core::TargetKind;pub use generate::generate_html_remediation_prompt;pub use generate::generate_llms_txt;pub use generate::generate_metadata_recommendations;pub use generate::generate_phoenix_remediation_prompt;pub use generate::LlmProvider;pub use generate::LlmProviderConfig;pub use generate::MetadataRecommendation;pub use generate::OllamaProvider;pub use generate::OpenAiCompatibleProvider;pub use html::disallowed_paths;pub use html::is_disallowed;pub use html::is_site_root_path;pub use html::load_pages;pub use html::normalize_path_separators;pub use html::normalize_url;pub use html::parse_html;pub use html::resolve_internal_path;pub use html::urls_from_sitemap_xml;pub use html::CrawlOptions;pub use html::Heading;pub use html::HtmlPage;pub use html::ImageInfo;pub use html::JsonLdBlock;pub use html::LinkInfo;pub use html::LoadOptions;pub use report::format_console;pub use report::format_html;pub use report::format_json;pub use report::format_markdown;pub use report::format_sarif;pub use report::ReportFormat;