Docs & Resources

Get up and running in under 30 minutes

CitrusIQ is in early access. Our documentation is growing — and every early user gets direct onboarding from the founding team. No ticket queue.

Full documentation launching with GA — track progress via early access.
CitrusIQ — terminal
$CitrusIQ extract https://example.com/products \
$ --schema product.json --output ./dataset
✓ JavaScript rendering enabled (Chrome headless)
✓ 1,240 records extracted across 52 pages
✓ Schema validation passed — 0 rejected
✓ Dataset exported → ./dataset/products.jsonl
Throughput: 847 records/min · Elapsed: 1m 28s
$
Getting Started

Your first pipeline in 4 steps

During early access, onboarding is done live with the team. Here's what to expect.

Step 01

Request access

Join the early access program. You'll get a direct onboarding call with the founding team within 24 hours.

Step 02

Connect your source

Point CitrusIQ at any website. It auto-detects JS rendering requirements, pagination, and auth flows.

Step 03

Define your schema

Tell CitrusIQ what fields you need — or let AI infer the structure from the page automatically.

Step 04

Schedule & deliver

Set a cron schedule or trigger. Data lands in your warehouse, CRM, or webhook on every run.

Configuration Reference

Pipeline configuration

Every CitrusIQ pipeline is defined by a JSON config. Here's a production-ready example.

pipeline.config.json
Example configuration
// CitrusIQ pipeline config
{
  "pipeline": "product-monitor",
  "schedule": "0 */6 * * *",
  "extractor": {
    "url": "https://store.example.com/products",
    "js_render": true,
    "pagination": "auto"
  },
  "schema": {
    "name": "string",
    "price": "number",
    "in_stock": "boolean",
    "sku": "string"
  },
  "export": {
    "format": "jsonl",
    "destination": "warehouse"
  }
}

What this pipeline does

  • Runs every 6 hours on a cron schedule
  • Renders JavaScript with headless Chrome
  • Auto-detects and follows pagination
  • Enforces typed schema on every record
  • Exports JSONL to your data warehouse
CLI Reference

Common CLI commands

Quick reference

CitrusIQ init

Initialize a new project

CitrusIQ run <id>

Execute a pipeline run

CitrusIQ status

Check pipeline run status

CitrusIQ export --format jsonl

Export dataset as JSONL

Support

Early access means real humans, not tickets

Every early access customer works directly with the founding team. You're not submitting tickets — you're working with the people who built it.

Getting started

Walk through your first pipeline end-to-end with a founder on a live call.

Book onboarding call

Pipeline configuration

Questions about schema design, scheduling, or output formats? Reach out directly.

Ask the team

Troubleshooting

Auth issues, JS rendering edge cases, pagination problems — we debug with you.

Get help
Get Started

Your first pipeline runs in under 30 minutes

Get early access and we'll set up your first pipeline together on a live call.