Getting started

Prerequisites

You must have Node.js v18 or higher installed. tsx aims to support the LTS versions of Node.js.

Quick try

If you want to try tsx without installing it, you can use it with npx.

In your command-line, simply pass in a TypeScript file you'd like to run:

npx tsx ./script.ts

Installation

Install to a project

If you want to add tsx as a development dependency to an npm project, cd into the project and run the following:

npm

$ npm install -D tsx

pnpm

$ pnpm install -D tsx

Using tsx

Once installed, you can invoke it with your package manager while in the project directory:

npm

$ npx tsx ./file.ts

pnpm

$ pnpm tsx ./file.ts

Using it in scripts

Common commands can be added to package.json#scripts

You can reference tsx directly in the command like so (you don't need npx):

{
    // ...

    "scripts": {
        "dev": "tsx ./file.ts"
    },

    // ...
}

Install globally

If you want to use tsx anywhere on your computer (without npx), install it globally:

npm

$ npm install -g tsx

pnpm

$ pnpm install -g tsx

Then, you can call tsx directly:

tsx file.ts