nadle/README.md

A type-safe, Gradle-inspired task runner for Node.js. Sharp tasks. Fast builds.

<h1 align="center">
Nadle
</h1>
<p align="center">
Gradle-inspired task runner for Node.js.
<p>
<p align="center">
  <a href="https://www.npmjs.com/package/nadle"><img src="https://img.shields.io/npm/v/nadle?color=3B7FC4&label="></a>
<p>

<p align="center">
<a href="https://www.nadle.dev/docs/why-nadle">Why</a> |
<a href="https://www.nadle.dev/docs/getting-started/installation">Installation</a> |
<a href="https://www.nadle.dev/docs/getting-started/features">Features</a> |
<a href="https://www.nadle.dev/docs/getting-started/playground">Playground</a> |
<a href="https://www.nadle.dev/docs/config-reference">Configuration Reference</a>
</p>

<p align="center">
<a href="https://pkg.pr.new/~/nadlejs/nadle"><img alt="pkg.new.pr" src="https://pkg.pr.new/badge/nadlejs/nadle?style=flat&color=3B7FC4"></a>
<a href="https://npmjs.com/package/nadle"><img src="https://img.shields.io/npm/dm/nadle?style=flat&colorA=17334F&colorB=3B7FC4" alt="npm downloads"></a>
<a href="https://github.com/nadlejs/nadle/actions/workflows/ci.yml"><img alt="ci" src="https://img.shields.io/github/actions/workflow/status/nadlejs/nadle/ci.yml?branch=main&label=CI&labelColor=17334F&color=3B7FC4"></a>
<a href="https://github.com/nadlejs/nadle/blob/main/LICENSE"><img alt="license" src="https://img.shields.io/github/license/nadlejs/nadle?labelColor=17334F&color=3B7FC4"></a>
</p>

![Demo](https://raw.githubusercontent.com/nadlejs/nadle/main/.assets/demo.gif)

## Features

- **Type-safe task definitions** — full TypeScript inference and compile-time checks
- **Parallel execution** — DAG-based scheduling with worker threads
- **Built-in caching** — input fingerprinting and output snapshots for incremental builds
- **Monorepo-native** — first-class support for multi-package workspaces
- **Built-in tasks** — ExecTask, PnpmTask, CopyTask, DeleteTask ready to use
- **Smart CLI** — abbreviation matching, auto-correction, dry run, summary mode
- **Zero legacy** — ESM-only, Node.js 22+, no backwards-compatibility baggage

## Quick Start

Install Nadle:

```bash
npm install -D nadle
```

Create a `nadle.config.ts`:

```ts
import { tasks } from "nadle";

tasks.register("hello", async () => {
	console.log("Hello from Nadle!");
});

tasks.register("goodbye", async () => {
	console.log("Goodbye!");
});

tasks.register("greet").config({
	group: "Greeting",
	description: "Run all greeting tasks",
	dependsOn: ["hello", "goodbye"]
});
```

Run it:

```bash
npx nadle greet
```

## Nadle Builds Itself

This repository uses Nadle as its own build system — see [`nadle.config.ts`](./nadle.config.ts) for a real-world example with caching, parallel execution, and monorepo task orchestration.

## Credits

Thanks to:

- The [Gradle team](https://gradle.org/) and community for inspiring Nadle's API and dependency model.
- The [Vitest team](https://vitest.dev/) for their excellent testing framework and for the reporter logic we reuse.

## Contribution

See [Contributing Guide](https://github.com/nadlejs/nadle/blob/main/CONTRIBUTING.md)

## License

[MIT](./LICENSE) License © 2025-Present [Nam Hoang Le](https://github.com/nam-hle)