pkupuk
ad8e2e313e
Add configuration for BMad, Claude, OpenCode, and other AI agent tools and workflows.
196 lines
4.2 KiB
Markdown
196 lines
4.2 KiB
Markdown
# Global Options Reference
|
|
|
|
Options that affect all tasks. Full docs: https://turborepo.dev/docs/reference/configuration
|
|
|
|
## globalEnv
|
|
|
|
Environment variables affecting all task hashes.
|
|
|
|
```json
|
|
{
|
|
"globalEnv": ["CI", "NODE_ENV", "VERCEL_*"]
|
|
}
|
|
```
|
|
|
|
Use for variables that should invalidate all caches when changed.
|
|
|
|
## globalDependencies
|
|
|
|
Files that affect all task hashes.
|
|
|
|
```json
|
|
{
|
|
"globalDependencies": [
|
|
"tsconfig.json",
|
|
".env",
|
|
"pnpm-lock.yaml"
|
|
]
|
|
}
|
|
```
|
|
|
|
Lockfile is included by default. Add shared configs here.
|
|
|
|
## globalPassThroughEnv
|
|
|
|
Variables available to tasks but not included in hash.
|
|
|
|
```json
|
|
{
|
|
"globalPassThroughEnv": ["AWS_SECRET_KEY", "GITHUB_TOKEN"]
|
|
}
|
|
```
|
|
|
|
Use for credentials that shouldn't affect cache keys.
|
|
|
|
## cacheDir
|
|
|
|
Custom cache location. Default: `node_modules/.cache/turbo`.
|
|
|
|
```json
|
|
{
|
|
"cacheDir": ".turbo/cache"
|
|
}
|
|
```
|
|
|
|
## daemon
|
|
|
|
Background process for faster subsequent runs. Default: `true`.
|
|
|
|
```json
|
|
{
|
|
"daemon": false
|
|
}
|
|
```
|
|
|
|
Disable in CI or when debugging.
|
|
|
|
## envMode
|
|
|
|
How unspecified env vars are handled. Default: `"strict"`.
|
|
|
|
```json
|
|
{
|
|
"envMode": "strict" // Only specified vars available
|
|
// or
|
|
"envMode": "loose" // All vars pass through
|
|
}
|
|
```
|
|
|
|
Strict mode catches missing env declarations.
|
|
|
|
## ui
|
|
|
|
Terminal UI mode. Default: `"stream"`.
|
|
|
|
```json
|
|
{
|
|
"ui": "tui" // Interactive terminal UI
|
|
// or
|
|
"ui": "stream" // Traditional streaming logs
|
|
}
|
|
```
|
|
|
|
TUI provides better UX for parallel tasks.
|
|
|
|
## remoteCache
|
|
|
|
Configure remote caching.
|
|
|
|
```json
|
|
{
|
|
"remoteCache": {
|
|
"enabled": true,
|
|
"signature": true,
|
|
"timeout": 30,
|
|
"uploadTimeout": 60
|
|
}
|
|
}
|
|
```
|
|
|
|
| Option | Default | Description |
|
|
| --------------- | ---------------------- | ------------------------------------------------------ |
|
|
| `enabled` | `true` | Enable/disable remote caching |
|
|
| `signature` | `false` | Sign artifacts with `TURBO_REMOTE_CACHE_SIGNATURE_KEY` |
|
|
| `preflight` | `false` | Send OPTIONS request before cache requests |
|
|
| `timeout` | `30` | Timeout in seconds for cache operations |
|
|
| `uploadTimeout` | `60` | Timeout in seconds for uploads |
|
|
| `apiUrl` | `"https://vercel.com"` | Remote cache API endpoint |
|
|
| `loginUrl` | `"https://vercel.com"` | Login endpoint |
|
|
| `teamId` | - | Team ID (must start with `team_`) |
|
|
| `teamSlug` | - | Team slug for querystring |
|
|
|
|
See https://turborepo.dev/docs/core-concepts/remote-caching for setup.
|
|
|
|
## concurrency
|
|
|
|
Default: `"10"`
|
|
|
|
Limit parallel task execution.
|
|
|
|
```json
|
|
{
|
|
"concurrency": "4" // Max 4 tasks at once
|
|
// or
|
|
"concurrency": "50%" // 50% of available CPUs
|
|
}
|
|
```
|
|
|
|
## futureFlags
|
|
|
|
Enable experimental features that will become default in future versions.
|
|
|
|
```json
|
|
{
|
|
"futureFlags": {
|
|
"errorsOnlyShowHash": true
|
|
}
|
|
}
|
|
```
|
|
|
|
### `errorsOnlyShowHash`
|
|
|
|
When using `outputLogs: "errors-only"`, show task hashes on start/completion:
|
|
|
|
- Cache miss: `cache miss, executing <hash> (only logging errors)`
|
|
- Cache hit: `cache hit, replaying logs (no errors) <hash>`
|
|
|
|
## noUpdateNotifier
|
|
|
|
Disable update notifications when new turbo versions are available.
|
|
|
|
```json
|
|
{
|
|
"noUpdateNotifier": true
|
|
}
|
|
```
|
|
|
|
## dangerouslyDisablePackageManagerCheck
|
|
|
|
Bypass the `packageManager` field requirement. Use for incremental migration.
|
|
|
|
```json
|
|
{
|
|
"dangerouslyDisablePackageManagerCheck": true
|
|
}
|
|
```
|
|
|
|
**Warning**: Unstable lockfiles can cause unpredictable behavior.
|
|
|
|
## Git Worktree Cache Sharing (Pre-release)
|
|
|
|
When working in Git worktrees, Turborepo automatically shares local cache between the main worktree and linked worktrees.
|
|
|
|
**How it works:**
|
|
|
|
- Detects worktree configuration
|
|
- Redirects cache to main worktree's `.turbo/cache`
|
|
- Works alongside Remote Cache
|
|
|
|
**Benefits:**
|
|
|
|
- Cache hits across branches
|
|
- Reduced disk usage
|
|
- Faster branch switching
|
|
|
|
**Disabled by**: Setting explicit `cacheDir` in turbo.json.
|