Project status: Cited v0.1.0 is the first public community release. Self-host with Docker Compose, or use Cited Cloud for managed hosting.
Why Cited exists
Marketing teams need evidence when AI assistants cite, mention, or recommend their brand. Cited runs the prompts you care about, captures immutable response snapshots, and surfaces citations, competitor appearances, and missed opportunities in one workspace.
Core capabilities
- Citation monitoring across configured prompts and supported surfaces
- Competitor tracking and missed-opportunity detection
- Evidence ledger with exports and notebook notes
- Inbox for review workflows
- Self-hosted Docker installation with secure secret generation
- Mock provider for offline demos with clearly labeled fictional data
- DataForSEO adapter with bring-your-own credentials for live monitoring
How it works
- Verify your domain and configure your brand
- Add monitored prompts and choose AI surfaces
- The worker schedules scan runs through your provider adapter
- Cited classifies citations, mentions, recommendations, and competitor events
- Evidence lands in the inbox and notebook; notifications fire when enabled
Supported surfaces
| Surface | Mock provider | DataForSEO (BYO credentials) |
|---|
| ChatGPT | Fictional demo data | Provider-dependent |
| Gemini | Fictional demo data | Provider-dependent |
| Perplexity | Fictional demo data | Provider-dependent |
| Claude | Fictional demo data | Provider-dependent |
| Google AI Overviews | Fictional demo data | Provider-dependent |
| Google AI Mode | Fictional demo data | Provider-dependent |
Mock mode uses fictional data labeled [MOCK]. DataForSEO requires operator-supplied credentials.
Quickstart
Prerequisites: Docker Compose v2, Node.js 22+, 4 GB RAM recommended.
npm ci
npm run self-host:up
Then:
- Retrieve the bootstrap token:
npm run self-host:token
- Open
/setup and create the first owner
- Sign in at
/sign-in
Default URL: http://localhost:3000. Secrets are generated in .cited/secrets/ and are never printed automatically. Stop without deleting data: npm run self-host:down. Diagnostics: npm run self-host:doctor.
Full guide: docs/getting-started/quickstart.md
First mock scan
Follow the first monitor tutorial to add fictional domains (cited-test.example), competitors (competitor-labs.example), prompts, and surfaces in mock mode. Optional demo fixtures: npm run db:seed.
Real DataForSEO setup
- Obtain DataForSEO API credentials
- Configure provider and credentials in
.cited/config.env per DataForSEO guide
- Restart:
npm run self-host:down && npm run self-host:up
Architecture
flowchart LR
User[Browser] --> Web[Web]
Web --> DB[(PostgreSQL)]
Worker[Worker] --> DB
Worker --> Web
Worker --> Provider[Provider adapter]
Provider --> Mock[Mock · fictional]
Provider --> DFS[DataForSEO · optional]
Detailed reference: docs/reference/architecture.md
Self-hosted vs Cited Cloud
| Community edition | Cited Cloud |
|---|
| Hosting | Self-hosted Docker | Managed |
| Auth | Local credentials | Managed service |
| DataForSEO | Bring your own | Managed infrastructure |
| Billing | Not required | Managed plans (may change) |
See feature matrix. Container images publish to ghcr.io/cited-cc/cited on release tags.
Security and privacy
- Secrets in
.cited/secrets/ with restrictive permissions
- Mock mode makes no external provider calls
- Security reports: SECURITY.md (private disclosure)
- Operator guides: docs/security/
Cited is not claimed to be penetration-tested or certified for regulated compliance frameworks.
Documentation
Quality checks
npm run lint && npm run typecheck && npm run test
npm run docs:check && npm run readme:check && npm run assets:check
npm run ci:check && npm run publication:check
Contributing
Contributions require DCO signoff under AGPL-3.0-only. See CONTRIBUTING.md and DCO.md.
Roadmap
Directional milestones (not promises): ROADMAP.md
License and trademark
Source code: AGPL-3.0-only. Trademarks: TRADEMARKS.md. This is not legal advice.
Managed Cited
Prefer not to operate infrastructure? Cited Cloud is an optional managed service at cited.cc.
