HonestRoles Documentation

HonestRoles is a deterministic, config-driven runtime for processing job datasets with Polars and optional plugins.

Use the App First

Use honestroles.com for fastest results

If your goal is job matching and analysis in the browser, start in the app and complete the workflow in minutes.

Open HonestRoles App Read App Quickstart

If your goal is to use HonestRoles (not build integrations), start here:

1. App Quickstart
2. Upload Data
3. Run Analysis
4. Export Results

Choose Your Path

• App user (browser): start at honestroles.com
• Developer/integrator: use the sections below

Developer Start Here

1. Install HonestRoles: Installation
2. Get a guaranteed first successful run: Quickstart (First Run)
3. Understand and customize your pipeline: Configure Pipeline

Developer Paths

• Run with the CLI: Run via CLI
• Ingest from public ATS APIs: Ingest from Public ATS APIs
• Run with Python: Run via Python API
• Read outputs and diagnostics: Understand Output
• Handle failures and recovery: Non-Fail-Fast and Recovery
• Build custom plugins: Author Plugins

Developer Reference

• CLI commands and exit codes: CLI Reference
• Runtime API: Runtime API
• Ingestion batch manifest schema: Ingest Manifest Schema
• Ingestion quality policy schema: Ingest Quality Policy Schema
• Connector source-ref map: Ingest Source-Ref Glossary
• Pipeline schema: Pipeline Config Schema
• Reliability policy schema: Reliability Policy Schema
• Plugin schema and ABI: Plugin Manifest Schema
• Stage contracts and behavior: Stage Contracts
• Errors and failure model: Error Model

Need Help

• Frequent issues: Common Errors
• Short answers: FAQ

Maintainer Ops

• Release runbook: Release and PyPI