Convex
Configuration for Convex project settings
| Type | object |
|---|---|
| File match |
convex.json
|
| Schema URL | https://catalog.lintel.tools/schemas/schemastore/convex/latest.json |
| Source | https://raw.githubusercontent.com/get-convex/convex-backend/refs/heads/main/npm-packages/convex/schemas/convex.schema.json |
Validate with Lintel
npx @lintel/lintel checkConfiguration schema for Convex project settings.
Documentation: https://docs.convex.dev/production/project-configuration#convexjson
Properties
Node.js specific configuration for server-side packages and dependencies.
2 nested properties
List of packages that should be installed on the server instead of being bundled. Use this for packages that can't be bundled or need to be installed directly on the server.
If you want to mark all dependencies as external, you can use the string '*' instead of an array.
Documentation: https://docs.convex.dev/functions/bundling#external-packages
[
"*"
]The Node.js version to use for Node.js actions. The currently supported values are '18', '20', and '22'.
Documentation: https://docs.convex.dev/production/project-configuration#configuring-the-nodejs-version
When true, generates CommonJS-compatible API files for projects not using ES modules. Enable this if your project uses require() syntax instead of ES modules.
Documentation: https://docs.convex.dev/client/javascript/node#javascript-with-commonjs-require-syntax
Path to the directory containing Convex functions. You can customize this to use a different location than the default 'convex/' directory.
Documentation: https://docs.convex.dev/production/project-configuration#changing-the-convex-folder-name-or-location
Configuration for Convex code generation.
4 nested properties
The file format of generated code. "ts" generates combined .ts files (recommended for TypeScript projects), "js/dts" generates separate .js and .d.ts files.
Note: "js/dts" must be used when using generateCommonJSApi.
When true, generates inline expanded types for component APIs. When false (recommended), generates import-based component API references instead.
When true, generates static api.d.ts files, which improves autocomplete and incremental typechecking performance in large codebases.
Documentation: https://docs.convex.dev/production/project-configuration#using-static-code-generation-beta
When true, generates static dataModel.d.ts files, which improves autocomplete and incremental typechecking performance in large codebases.
Documentation: https://docs.convex.dev/production/project-configuration#using-static-code-generation-beta
Configuration for module bundling and source map generation.
1 nested properties
Whether to include original source code in source maps. Set to false to reduce bundle size.
TypeScript compiler to use for typechecking (@typescript/native-preview must be installed to use tsgo)
WorkOS AuthKit integration configuration.
Documentation: https://docs.convex.dev/auth/authkit/auto-provision
3 nested properties
AuthKit configuration for development deployments.
2 nested properties
If false, disables automatic configuration of the WorkOS environment. Otherwise configures the WorkOS environment with these settings.
If false, disables automatically writing local environment variables. Otherwise writes the given mapping to the local .env file.
AuthKit configuration for preview deployments.
2 nested properties
If false, disables automatic configuration of the WorkOS environment. Otherwise configures the WorkOS environment with these settings.
Preview deployments must configure environment variables directly in the deployment platform; only false is allowed here.
AuthKit configuration for production deployments.
3 nested properties
WorkOS environment type. Only supported in the prod section.
If false, disables automatic configuration of the WorkOS environment. Otherwise configures the WorkOS environment with these settings.
Prod deployments must configure environment variables directly in the deployment platform; only false is allowed here.
User-configurable settings for Convex AI files behavior.
2 nested properties
When false, disables all Convex AI files prompts and staleness messages in npx convex dev. Use npx convex ai-files enable to re-enable.
Deprecated. Use enabled instead.
Definitions
WorkOS AuthKit environment configuration settings.
Documentation: https://docs.convex.dev/auth/authkit/auto-provision
Allowed redirect URIs configured in WorkOS.
Application homepage URL configured in WorkOS.
Allowed CORS origins configured in WorkOS.
If false, disables automatic configuration of the WorkOS environment. Otherwise configures the WorkOS environment with these settings.
If false, disables automatically writing local environment variables. Otherwise writes the given mapping to the local .env file.
AuthKit configuration for development deployments.
If false, disables automatic configuration of the WorkOS environment. Otherwise configures the WorkOS environment with these settings.
If false, disables automatically writing local environment variables. Otherwise writes the given mapping to the local .env file.
AuthKit configuration for preview deployments.
If false, disables automatic configuration of the WorkOS environment. Otherwise configures the WorkOS environment with these settings.
Preview deployments must configure environment variables directly in the deployment platform; only false is allowed here.
AuthKit configuration for production deployments.
WorkOS environment type. Only supported in the prod section.
If false, disables automatic configuration of the WorkOS environment. Otherwise configures the WorkOS environment with these settings.
Prod deployments must configure environment variables directly in the deployment platform; only false is allowed here.
WorkOS AuthKit integration configuration.
Documentation: https://docs.convex.dev/auth/authkit/auto-provision
AuthKit configuration for development deployments.
2 nested properties
If false, disables automatic configuration of the WorkOS environment. Otherwise configures the WorkOS environment with these settings.
If false, disables automatically writing local environment variables. Otherwise writes the given mapping to the local .env file.
AuthKit configuration for preview deployments.
2 nested properties
If false, disables automatic configuration of the WorkOS environment. Otherwise configures the WorkOS environment with these settings.
Preview deployments must configure environment variables directly in the deployment platform; only false is allowed here.
AuthKit configuration for production deployments.
3 nested properties
WorkOS environment type. Only supported in the prod section.
If false, disables automatic configuration of the WorkOS environment. Otherwise configures the WorkOS environment with these settings.
Prod deployments must configure environment variables directly in the deployment platform; only false is allowed here.