Cheattsx Run TypeScript directly
Light · Postcard
102 × 152 mm · PDF
Dark · Postcard
102 × 152 mm · PDF
Ink saver · Postcard
102 × 152 mm · PDF
Light · A4 landscape
297 × 210 mm · PDF
Dark · A4 landscape
297 × 210 mm · PDF
Ink saver · A4 landscape
297 × 210 mm · PDF
Light · A3 landscape
420 × 297 mm · PDF
Dark · A3 landscape
420 × 297 mm · PDF
Ink saver · A3 landscape
420 × 297 mm · PDF
Start here
npx tsx <file.ts>
Run a TS file, no setup
tsx <file.ts> <args>
Run with arguments
tsx watch <file.ts>
Rerun on change
tsxOpen a TS-aware REPL
npm i -D tsxAdd to a project
tsx --tsconfig <path> <file.ts>
Use another tsconfig
node --import tsx <file.ts>
Plain node with TS support
tsc --noEmitType-check (tsx will not)
Concepts
- file.ts your source
- tsx loader on top of node
- node runs the code
- Type errors found by tsc only
Install
npx tsx <file.ts>
Run once without installing
npm install -D tsx
Add to the project
Then call tsx from package.json scripts or via npx tsx.
npm install -g tsx
Install globally
tsx --versionShow tsx and node versions
Run
tsx <file.ts>
Run a TypeScript file
tsx <file.ts> <args>
Pass arguments to the script
Read them from process.argv.slice(2).
tsx -e "<code>"
Evaluate a TS snippet
tsx -p "<expr>"
Evaluate and print the result
tsx --import <module> <file.ts>
Preload a module first
tsx --env-file=<file> <file.ts>
Load env vars from a file
Node flag passed through; needs node 20.6+.
tsx --no-cache <file.ts>
Skip the compile cache
tsx --enable-source-maps <file.ts>
Source-mapped stack traces
./script.tsRun as an executable script
First line: #!/usr/bin/env tsx, then chmod +x.
Watch
tsx watch <file.ts>
Rerun when imported files change
tsx watch --include "<glob>"
<file.ts>
Also watch extra paths
Quote globs so the shell does not expand them.
tsx watch --exclude "<glob>"
<file.ts>
Do not watch these paths
tsx watch --clear-screen=false <file.ts>
Keep earlier output
Enter (in watch mode)
Rerun by hand
Config
tsx --tsconfig <path> <file.ts>
Use a specific tsconfig
TSX_TSCONFIG_PATH=<path> tsx <file.ts>
Same, set via the environment
TSX_DISABLE_CACHE=1 tsx <file.ts>
Disable the cache via the environment
Use with node
node --import tsx <file.ts>
Run TS with plain node
Also works in NODE_OPTIONS or a shebang.
node --import tsx --test
Run the node test runner on TS
tsx --testSame, shorter
node --require tsx/cjs <file.ts>
Register for CommonJS only
import { tsImport } from 'tsx/esm/api'
Import one TS file from JS
await tsImport('./file.ts', import.meta.url); not
cached.
tsx --inspect <file.ts>
Attach a debugger
tsx -iAlways enter the REPL
Recipes
"dev": "tsx watch src/index.ts","start": "tsx src/index.ts","typecheck": "tsc --noEmit"tsx watch --env-file=.env --exclude "./logs/**" src/server.tstsc --noEmit && tsx src/job.ts <arg>node --import tsx --test "src/**/*.test.ts"
