tsrun is a lightweight TypeScript execution tool that lets you run .ts files directly—no build step required. It's like running JavaScript with node, but for TypeScript. Under the hood, tsrun uses tsx for lightning-fast execution while keeping your workflow simple and efficient.

Installation

npm install -g @git.zone/tsrun

Or as a project dependency:

npm install --save-dev @git.zone/tsrun

Usage

🚀 CLI Usage

Simply run any TypeScript file:

tsrun myScript.ts

Pass arguments to your script transparently:

tsrun myScript.ts --config production --verbose

All arguments are passed through to your TypeScript program, just as if you were running it with node.

💻 Programmatic API

Import tsrun in your code for dynamic TypeScript execution:

import { runPath, runCli } from '@git.zone/tsrun';

// Run a TypeScript file from an absolute or relative path
await runPath('./scripts/myScript.ts');

// Run with path resolution relative to a file URL
await runPath('./myScript.ts', import.meta.url);

// Run in CLI mode programmatically (respects process.argv)
await runCli('./myScript.ts');

Features

✨ Zero Configuration - Just point and shoot. No tsconfig tweaking required.

⚡ Fast Execution - Powered by tsx for near-instant TypeScript execution.

🔄 Transparent Arguments - Command line arguments pass through seamlessly to your scripts.

📦 Dual Interface - Use as a CLI tool or import as a library in your code.

🎯 TypeScript Native - Full TypeScript support with excellent IntelliSense.

Why tsrun?

Sometimes you just want to run a TypeScript file without setting up a build pipeline, configuring webpack, or waiting for tsc to compile. That's where tsrun shines:

Quick Scripts: Write and run TypeScript scripts as easily as bash scripts
Prototyping: Test ideas without project setup overhead
Development Workflows: Integrate TypeScript execution into your tooling
CI/CD: Run TypeScript-based build scripts without pre-compilation

Examples

Simple Script

// hello.ts
console.log('Hello from TypeScript! 🎉');

const greet = (name: string): string => {
  return `Welcome, ${name}!`;
};

console.log(greet('Developer'));

Run it:

tsrun hello.ts
# Output:
# Hello from TypeScript! 🎉
# Welcome, Developer!

With Command Line Arguments

// deploy.ts
const environment = process.argv[2] || 'development';
const verbose = process.argv.includes('--verbose');

console.log(`Deploying to ${environment}...`);
if (verbose) {
  console.log('Verbose mode enabled');
}

Run it:

tsrun deploy.ts production --verbose
# Output:
# Deploying to production...
# Verbose mode enabled

Programmatic Execution

// runner.ts
import { runPath } from '@git.zone/tsrun';

const scripts = [
  './scripts/setup.ts',
  './scripts/migrate.ts',
  './scripts/seed.ts'
];

for (const script of scripts) {
  console.log(`Running ${script}...`);
  await runPath(script, import.meta.url);
  console.log(`✓ ${script} completed`);
}

Package Information

npmjs: @git.zone/tsrun
Source: git.zone | GitLab Mirror | GitHub Mirror
Documentation: TypeDoc

Requirements

Node.js: >= 16.x
TypeScript: >= 3.x (automatically handled by tsx)

License and Legal Information

This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the license file within this repository.

Please note: The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.

Trademarks

This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.

readme.md

@git.zone/tsrun

What is tsrun?