Configuration
Configure Oorty with the oorty.json manifest file.
oorty.json
The oorty.json file is the configuration manifest for your project. It is created automatically when you run oorty init.
1{2 "$schema": "https://oorty.dev/schema.json",3 "framework": "nextjs",4 "typescript": true,5 "srcDir": false,6 "testRunner": "vitest",7 "e2eRunner": "playwright",8 "directories": {9 "unit": "tests/unit",10 "component": "tests/component",11 "e2e": "tests/e2e",12 "plans": ".oorty/plans"13 },14 "ci": {15 "provider": "github-actions",16 "runOnPush": true,17 "runOnPR": true18 }19}Schema Reference
$schema
URL to the JSON schema for IDE autocompletion and validation.
framework
The detected framework. Supported values:
nextjs- Next.jsreact- React (Create React App or custom)vite- Vite + Reactremix- Remixastro- Astronuxt- Nuxtsvelte- SvelteKit
typescript
Whether to use TypeScript for test files. Default: true
srcDir
Whether your project uses a src directory structure. This affects path aliases in test files.
testRunner
The unit and component test runner. Options:
vitest- Vitest (recommended)jest- Jest
e2eRunner
The end-to-end test runner. Options:
playwright- Playwright (recommended)cypress- Cypress
directories
Custom paths for test directories. All paths are relative to the project root. Plans now default to .oorty/plans as part of the .oorty/ single source of truth.
{ "directories": { "unit": "tests/unit", "component": "tests/component", "e2e": "tests/e2e", "plans": ".oorty/plans" }}ci
CI/CD configuration. Set to null to disable CI workflow generation.
{ "ci": { "provider": "github-actions", "runOnPush": true, "runOnPR": true }}Environment Variables
Oorty uses the following environment variables:
| Variable | Description |
|---|---|
OPENAI_API_KEY | Required for Pro oorty plan / oorty generate when using OpenAI (set in your shell or a project .env) |
ANTHROPIC_API_KEY | Dashboard API key for Pro AI (oorty plan, oorty generate) |
DEBUG | Enable debug logging when set to any value |
Next: Vitest Setup
Learn about the generated Vitest configuration.