Configuration

Run orstrum init to generate an orstrum.config.ts in your project root, or write one by hand. Orstrum auto-discovers it (orstrum.config.ts, .js, or .json); pass --config <path> to any command to override.

import type  OrstrumConfig  from 'orstrum';

const config: OrstrumConfig = 
  repos: [
    
      name: 'my-app',
      path: '.',                       // scan the current directory
      packageNames: [],
    ,
    
      name: 'shared-ui',
      path: '../shared-ui',
      packageNames: ['@acme/shared-ui'],
    ,
  ],

  // Optional — only needed for LLM purpose summaries
  providers: 
    anthropic:  apiKeyEnv: 'ORSTRUM_ANTHROPIC_API_KEY' ,
  ,
;

export default config;

Cloud sync is not configured here — orstrum login stores your workspace token in ~/.orstrum/credentials.json, and orstrum push / serve --cloud read it from there.

Options

repos required

array

List of repositories to scan. Must have at least one entry.

repos[].name required

string

Friendly name for this repo. Used to disambiguate paths in MCP tool calls and as the repo's key in the graph.

repos[].path required

string

Path to the repo root — absolute or relative to the config file. A tsconfig.json is optional; when present, its path aliases are resolved.

repos[].packageNames

string[]

The npm package name(s) this repo publishes. Imports of these names from other repos resolve to this repo instead of being treated as external packages.

repos[].sourceRoots

string[]

Directories to scan, relative to the repo root. Defaults to ["src"] — set this if your code lives in lib/, app/, packages, or the repo root, otherwise the scan finds 0 files.

repos[].ignore

string[]

Extra glob ignores layered on top of .gitignore and Orstrum's built-in defaults.

repos[].glossary

object

Map of project-specific terms (abbreviations, codenames, prefixes) to their meaning. Injected into the summary prompt so LLM purposes use your team's vocabulary.

providers.anthropic.apiKeyEnv

string

Name of the environment variable holding your Anthropic API key, used for orstrum summarize. Defaults to ORSTRUM_ANTHROPIC_API_KEY. Only the env-var name is stored — never the key itself.

Multiple repos

All repos in a single config share one graph.db and are served by the same MCP server. Use the repo parameter in MCP tool calls to narrow results to a specific repo when paths are ambiguous.