tsx

library4.21.0jsnpmunverified

tsx (TypeScript Execute) is a command-line interface (CLI) tool that enhances Node.js by providing a seamless way to run TypeScript and ESM files directly, leveraging esbuild for fast transpilation. It allows developers to execute TypeScript without a separate compilation step. The current stable version is 4.21.0. The project is actively maintained with frequent minor releases and bug fixes, often occurring every few weeks.

devops

npm install tsx

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · TSX

tsx

devopsjavascriptv4.21.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Demonstrates how to run a TypeScript file directly using the `tsx` CLI without prior compilation.

/* my-script.ts */ function greet(name: string) { console.log(`Hello, ${name}!`); } greet('TypeScript'); // To run this: // npx tsx my-script.ts

tsx --version

Debug

Known issues

gotchatsx requires Node.js version 18.0.0 or higher. Running with an older version will result in an error.

fix

Upgrade your Node.js runtime to version 18.0.0 or newer using a version manager like nvm or volta.

affects: >=4.0.0

gotchatsx overrides Node.js's native experimental TypeScript loader, meaning its behavior might differ from Node.js's built-in TypeScript execution.

fix

Be aware that tsx manages TypeScript transpilation independently of Node.js's native --loader options.

affects: >=4.20.4

gotchatsx uses esbuild for transpilation, which performs no type checking during execution. Type errors in your code will not prevent a script from running.

fix

Use a separate type checker (e.g., tsc --noEmit) in your development workflow or CI/CD pipeline for type validation.

affects: >=1.0.0

gotchaWhile tsx generally handles tsconfig.json `paths` and `baseUrl`, complex tsconfig configurations or specific `compilerOptions` might not be fully supported by its underlying esbuild transpiler.

fix

Simplify tsconfig.json if possible, or verify specific compilerOptions behavior. Ensure baseUrl is correctly configured if using path aliases.

affects: >=1.0.0

Errors

Common errors & fixes

Error: The tsx runtime requires Node.js version 18 or higher.

The installed Node.js version is below the minimum requirement specified in the package's engines field.

fix

Upgrade Node.js to version 18.0.0 or newer using a version manager like nvm or volta.

tsx: command not found

The tsx CLI executable is not installed globally or is not accessible in your system's PATH.

fix

Install tsx globally via `npm install -g tsx` or execute it using `npx tsx <your-script.ts>`.

Cannot find module 'some-alias' from '...' or similar module resolution errors.

Path aliases defined in tsconfig.json might not be resolved correctly by tsx in some setups, or there's a misconfiguration in module resolution.

fix

Ensure your `baseUrl` and `paths` are correctly defined in `tsconfig.json`. tsx generally has good path alias support; verify project structure and import paths.

ReferenceError: require is not defined in ES module scope

Attempting to use the CommonJS `require` function within a file that Node.js (and tsx) treats as an ES module.

fix

Convert `require` statements to `import` statements, or ensure the file is explicitly treated as CommonJS (e.g., by using a `.cjs` extension or setting `type: "commonjs"` in the nearest `package.json`).

Upgrade

Version history

4.21.0latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

8 hits · last 30 days

node

Resources

githubhttps://github.com/privatenumber/tsx ↗

packagehttps://www.npmjs.com/package/tsx ↗

homepagehttps://tsx.hirok.io ↗