Skip to content
On this page

Command Line Interface



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.

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


Don't forget that Vitest runs with enabled watch mode by default. If you are using tools like lint-staged, you should also pass --run option, so that command can exit normally.

// .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.


-v, --versionDisplay version number
-r, --root <path>Define the project root
-c, --config <path>Path to config file
-u, --updateUpdate snapshots
-w, --watchSmart & instant watch mode
-t, --testNamePattern <pattern>Run tests with full names matching the pattern
--dir <path>Base directory to scan for the test files
--uiEnable UI
--openOpen the UI automatically if enabled (default: true)
--api [api]Serve API, available options: --api.port <port>, [host] and --api.strictPort
--threadsEnable Threads (default: true)
--single-threadRun tests inside a single thread, requires --threads (default: false)
--experimental-vm-threadsRun tests in a worker pool using VM isolation (default: false)
--experimental-vm-worker-memory-limitSet the maximum allowed memory for a worker. When reached, a new worker will be created instead
--silentSilent console output from tests
--isolateIsolate environment for each test file (default: true)
--reporter <name>Select reporter: default, verbose, dot, junit, json, or a path to a custom reporter
--outputFile <filename/-s>Write test results to a file when the --reporter=json or --reporter=junit option is also specified
Via cac's dot notation you can specify individual outputs for multiple reporters
--coverageEnable coverage report
--runDo not watch
--modeOverride Vite mode (default: test)
--mode <name>Override Vite mode (default: test)
--globalsInject APIs globally
--domMock browser api with happy-dom
--browser [options]Run tests in the browser (default: false)
--environment <env>Runner environment (default: node)
--passWithNoTestsPass when no tests found
--logHeapUsageShow the size of heap for each test
--allowOnlyAllow tests and suites that are marked as only (default: false in CI, true otherwise)
--dangerouslyIgnoreUnhandledErrorsIgnore any unhandled errors that occur
--changed [since]Run tests that are affected by the changed files (default: false). See docs
--shard <shard>Execute tests in a specified shard
--sequenceDefine in what order to run tests. Use cac's dot notation to specify options (for example, use --sequence.shuffle to run tests in random order or --sequence.shuffle --sequence.seed SEED_ID to run a specific order)
--no-colorRemoves colors from the console output
--inspectEnables Node.js inspector
--inspect-brkEnables Node.js inspector with break
--bail <number>Stop test execution when given number of tests have failed
--retry <times>Retry the test specific number of times if it fails
-h, --helpDisplay available CLI options


Vitest supports both camel case and kebab case for CLI arguments. For example, --passWithNoTests and --pass-with-no-tests will both work (--no-color and --inspect-brk are the exceptions).

Vitest also supports different ways of specifying the value: --reporter dot and --reporter=dot are both valid.

If option supports an array of values, you need to pass the option multiple times:

vitest --reporter=dot --reporter=default
vitest --reporter=dot --reporter=default

Boolean options can be negated with no- prefix. Specifying the value as false also works:

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


  • 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.


  • 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:

    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


You cannot use this option with --watch enabled (enabled in dev by default).

Released under the MIT License.