Command Line Interface ​

Commands ​

vitest ​

Start Vitest in the current directory. Will enter the watch mode in development environment and run mode in CI automatically.

You can pass an additional argument as the filter of the test files to run. For example:

vitest foobar

vitest foobar

Will run only the test file that contains foobar in their paths. This filter only checks inclusion and doesn't support regexp or glob patterns (unless your terminal processes it before Vitest receives the filter).

vitest run ​

Perform a single run without watch mode.

vitest watch ​

Run all test suites but watch for changes and rerun tests when they change. Same as calling vitest without an argument. Will fallback to vitest run in CI.

vitest dev ​

Alias to vitest watch.

vitest related ​

Run only tests that cover a list of source files. Works with static imports (e.g., import('./index.ts') or import index from './index.ts), but not the dynamic ones (e.g., import(filepath)). All files should be relative to root folder.

Useful to run with lint-staged or with your CI setup.

vitest related /src/index.ts /src/hello-world.js

vitest related /src/index.ts /src/hello-world.js

// .lintstagedrc.js
export default {
  '*.{js,ts}': 'vitest related --run',
}

// .lintstagedrc.js
export default {
  '*.{js,ts}': 'vitest related --run',
}

vitest bench ​

Run only benchmark tests, which compare performance results.

Options ​

vitest --reporter=dot --reporter=default

vitest --reporter=dot --reporter=default

vitest --no-api
vitest --api=false

vitest --no-api
vitest --api=false

changed ​

• Type: boolean | string

• Default: false

  Run tests only against changed files. If no value is provided, it will run tests against uncommitted changes (including staged and unstaged).

  To run tests against changes made in the last commit, you can use --changed HEAD~1. You can also pass commit hash or branch name.

  If paired with the forceRerunTriggers config option it will run the whole test suite if a match is found.

shard ​

• Type: string

• Default: disabled

  Test suite shard to execute in a format of <index>/<count>, where

  • count is a positive integer, count of divided parts
  • index is a positive integer, index of divided part

  This command will divide all tests into count equal parts, and will run only those that happen to be in an index part. For example, to split your tests suite into three parts, use this:

  sh

  vitest run --shard=1/3
  vitest run --shard=2/3
  vitest run --shard=3/3

  vitest run --shard=1/3
  vitest run --shard=2/3
  vitest run --shard=3/3