#The config file

Rune reads one file: rune.config.ts. It is TypeScript, it default-exports an object with a scripts map, and it may import other files in the repository.

import { defineConfig } from '@giancarlosio/rune';

export default defineConfig({
  scripts: {
    build: { command: 'tsc --build' },
    test: { command: 'vitest run', description: 'Run unit tests' },
  },
});

defineConfig is an identity function that supplies the types. A config that exports the object literal directly behaves identically and loses editor autocomplete.

#Discovery

Rune walks up from the working directory looking for rune.config.ts, and stops at the first directory containing a .git entry or at the filesystem root.

The boundary matters. Without it, a run from a scratch directory keeps walking and picks up an unrelated config from somewhere else on the machine, and the result depends on whose machine it is.

Two directories come out of that walk:

When no config is found:

$ rune list
error: no rune.config.ts found

searched upward from /tmp/scratch and stopped at the repository boundary.

create one at the root of your repository with:

  rune init

#The default export

The export is an object with one key.

Script names are arbitrary strings. rune list prints them sorted, so the order in the file has no effect on output.

A missing default export, or one that is not an object, is an error naming the file.

#Package-level configs

A package may hold its own rune.config.ts. Rune uses the nearest one, and a script defined there may extend a root script but never replace it. See Inheritance and overrides.

#Sections