Code Runner

Run code snippets or whole files for many languages — C, C++, Java, JavaScript, PHP, Python, Perl, Ruby, Go, Lua, Groovy, PowerShell, BAT/CMD, BASH/SH, F# Script, F# (.NET Core), C# Script, C# (.NET Core), VBScript, TypeScript, CoffeeScript, Scala, Swift, Julia, Crystal, OCaml Script, R, AppleScript, Elixir, Visual Basic .NET, Clojure, Haxe, Objective-C, Rust, Racket, Scheme, AutoHotkey, AutoIt, Kotlin, Dart, Free Pascal, Haskell, Nim, D, Lisp, Kit, V, SCSS, Sass, CUDA, Less, Fortran, Ring, Standard ML, Zig, Mojo, Erlang, SPWN, Pkl, Gleam, Bun, Deno — plus custom commands.

Features

• Run the code file of the current active text editor.
• Run a code file from the Explorer context menu.
• Run a selected code snippet in the text editor.
• Run code with custom command-line arguments (Ctrl+Alt+A).
• Interactive Status Bar item to run or stop code with a single click.
• Copy run command to clipboard to inspect or test in external terminals.
• Clear output channel command.
• Configurable process timeout to prevent runaway loops.
• Custom environment variables support per workspace/project.
• Run code according to its shebang line.
• Run code according to a filename glob.
• Run a custom command.
• Stop a running process.
• View output in the Output panel.
• Set a default language to run, or pick one per run.
• REPL-style workflows by running code in the Integrated Terminal.

Usage

To run code, use any of:

• shortcut Ctrl+Alt+N
• F1, then select/type Run Code
• right-click the editor and choose Run Code
• the Run Code button in the editor title menu
• the Run Code button in the Status Bar
• the Run Code item in the Explorer context menu

To run code with arguments:

• shortcut Ctrl+Alt+A
• F1, then select/type Run Code with Arguments
• right-click the editor and choose Run Code with Arguments

To stop a running process:

• shortcut Ctrl+Alt+M
• F1, then select/type Stop Code Run
• the Stop Code Run button in the editor title menu
• the Stop Code button in the Status Bar
• right-click the Output panel and choose Stop Code Run

To pick a language per run, use Ctrl+Alt+J (or F1 → Run By Language) and type/select a language id, e.g. php, javascript, bat, shellscript.

To run a custom command, use Ctrl+Alt+K (or F1 → Run Custom Command).

To copy the resolved run command, use F1 → Copy Run Command.

To clear the Code output channel, use F1 → Clear Output Channel.

Settings

Make sure every interpreter/compiler is on the system PATH, or point to it explicitly in code-runner.executorMap, e.g.:

{
  "code-runner.executorMap": {
    "javascript": "node",
    "php": "C:\\php\\php.exe",
    "python": "python",
    "ruby": "C:\\Ruby23-x64\\bin\\ruby.exe",
    "go": "go run",
    "html": "\"C:\\Program Files (x86)\\Google\\Chrome\\Application\\chrome.exe\"",
    "java": "cd $dir && javac $fileName && java $fileNameWithoutExt",
    "c": "cd $dir && gcc $fileName -o $fileNameWithoutExt && $dir$fileNameWithoutExt"
  }
}

Supported placeholders

Note about paths: escape backslashes as \\ and wrap paths containing spaces in \".

You may also set executors by filename glob:

{
  "code-runner.executorMapByGlob": {
    "pom.xml": "cd $dir && mvn clean package",
    "*.test.js": "tap",
    "*.js": "node"
  }
}

or by file extension:

{
  "code-runner.executorMapByFileExtension": {
    ".vbs": "cscript //Nologo"
  }
}

Set a default language to run:

{
  "code-runner.defaultLanguage": "javascript"
}

Set the custom command:

{
  "code-runner.customCommand": "echo Hello"
}

Set the working directory:

{
  "code-runner.cwd": "path/to/working/directory"
}

Other useful options (all "code-runner.<name>" settings):

About the current working directory

1. If code-runner.cwd is set, use it.
2. Otherwise, if code-runner.fileDirectoryAsCwd is true, use the directory of the file being run.
3. Otherwise, use the root folder open in VS Code.
4. If no folder is open, use the OS temporary directory.

Notes

• Objective-C is supported on macOS only.
• C# script support requires scriptcs.
• TypeScript support requires ts-node.
• Clojure support requires Leiningen and lein-exec.

Telemetry

This extension collects usage data by default to help improve it. Telemetry is sent through the official @vscode/extension-telemetry module and automatically respects the global telemetry.telemetryLevel setting. It can also be disabled per extension:

{
  "code-runner.enableAppInsights": false
}

Development

Requirements: Node.js 20+.

npm install          # install dependencies
npm run compile      # type-check + bundle (esbuild) into dist/
npm run watch        # watch mode
npm run lint         # eslint
npm test             # run unit tests (vitest) across platforms

Change Log

See CHANGELOG.md.

Issues

Report bugs or request features in the issue tracker.

Contribution

Fork the repository and submit pull requests.