Skip to content

Configuration

Input

repoRoot

Root of your workspace. Defaults to the working directory.

providerNames (optional): string[]

Explicitly select which dependency providers to use. Supported values: 'pnpm', 'bun', 'yarn', 'npm', 'mise', 'uv', 'go', 'rust'. When omitted, Dependicus auto-detects the active providers.

providers (optional): DependencyProvider[]

For advanced use cases, pass fully-constructed provider instances. This takes precedence over providerNames and auto-detection. See Package Managers for details.

Output

siteName

Name as it appears in the header and <title> tag of the HTML output. Defaults to Dependicus for ${rootDir dirname}.

CLI flag: --site-name <name>

outputDir

Where HTML and JSON output will be created. Defaults to ${repoRoot}/dependicus-out.

CLI flag: --output-dir <path>

dependicusBaseUrl

Base URL of where Dependicus will be deployed. Used for linking from Linear tickets and GitHub Issues.

CLI flag: --dependicus-base-url <url>

cacheDir

Dependicus aggressively caches data in individual JSON files. This parameter controls where they go. The default value is ${repoRoot}/.dependicus-cache.

CLI flag: --cache-dir <path>

For all of the above, the CLI flag takes precedence over the programmatic config value.

Linear

Dependicus assumes you want fine-grained control over how tickets are created. There is no default behavior because we aren’t confident enough to predict what you want.

linear.getLinearIssueSpec (optional): (context: VersionContext, store: FactStore) => LinearIssueSpec | undefined

For a given dependency version, return a LinearIssueSpec describing what ticket to create, or undefined to skip. See Linear tickets for details on the LinearIssueSpec fields.

This field is optional because plugins can provide the same functionality. Depending on how complex your setup is, you might choose to write a plugin instead of providing a function for this parameter.

If you do not write a plugin or pass a getLinearIssueSpec() function, then Dependicus cannot create Linear tickets for you.

linear.cooldownDays (optional, defaults to 0)

Wait at least this many days after a release before creating or updating tickets to include it.

CLI flag: --cooldown-days <days> on make-linear-issues

linear.allowNewIssues (optional, defaults to true)

You can set this to false to disable ticket creation, for example when running CI on pull requests.

CLI flag: --no-new-issues on make-linear-issues

linear.skipStateNames (optional): string[]

Skip updating issues whose Linear workflow state name matches any entry (case-insensitive). For example, if your Linear workspace has custom states like "PR" and "Verify" for issues that are actively being worked on, you can prevent Dependicus from overwriting them:

CLI flag: --skip-state <name> (repeatable) on make-linear-issues

linear.rateLimitDays (optional): number

Default notification rate limit in days. When a per-policy rateLimitDays is not set, this value is used as the fallback. Prevents frequent updates to notification-only tickets.

CLI flag: --rate-limit-days <days> on make-linear-issues

linear: {
    skipStateNames: ['pr', 'verify'],
}

When omitted (the default), Dependicus updates all non-closed issues regardless of state.

GitHub Issues

Dependicus can also create and manage GitHub Issues for outdated dependencies. Like Linear, there is no default behavior — you must provide a getGitHubIssueSpec() function or a plugin.

github.getGitHubIssueSpec (optional): (context: VersionContext, store: FactStore) => GitHubIssueSpec | undefined

For a given dependency version, return a GitHubIssueSpec describing what issue to create, or undefined to skip. See GitHub Issues for details.

github.cooldownDays (optional, defaults to 0)

Wait at least this many days after a release before creating or updating issues to include it.

CLI flag: --cooldown-days <days> on make-github-issues

github.allowNewIssues (optional, defaults to true)

You can set this to false to disable issue creation, for example when running CI on pull requests.

CLI flag: --no-new-issues on make-github-issues

github.rateLimitDays (optional): number

Default notification rate limit in days. When a per-policy rateLimitDays is not set, this value is used as the fallback.

CLI flag: --rate-limit-days <days> on make-github-issues

Plugins

To use plugins, pass an array of plugins as the value of the plugins parameter.

To write a plugin, read Writing Plugins!