https://github.com/listr2/listr2

NodeJS Task List derived from the best! Create beautiful CLI interfaces via easy and logical to implement task lists that feel alive and interactive.
https://github.com/listr2/listr2

cli console listr loading nodejs nodejs-modules npm progress task tasklist term terminal typescript

Last synced: 4 days ago
JSON representation

NodeJS Task List derived from the best! Create beautiful CLI interfaces via easy and logical to implement task lists that feel alive and interactive.

• Host: GitHub
• URL: https://github.com/listr2/listr2
• Owner: listr2
• License: mit
• Created: 2020-02-27T15:52:59.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2025-01-01T17:54:38.000Z (10 days ago)
• Last Synced: 2025-01-02T22:02:17.504Z (9 days ago)
• Topics: cli, console, listr, loading, nodejs, nodejs-modules, npm, progress, task, tasklist, term, terminal, typescript
• Language: TypeScript
• Homepage:
• Size: 12 MB
• Stars: 532
• Watchers: 5
• Forks: 31
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome - listr2/listr2 - NodeJS Task List derived from the best! Create beautiful CLI interfaces via easy and logical to implement task lists that feel alive and interactive. (TypeScript)
• awesome-nodejs - listr2 - Terminal task list. (Packages / Command-line utilities)
• awesome-nodejs-cn - listr2 - **star:534** 终端任务列表 (包 / 命令行实用工具)
• awesome-javascript - listr2
• awesome-javascript - listr2

README

        
# listr2 - monorepo

[![Pipeline](https://gitlab.kilic.dev/libraries/listr2/badges/master/pipeline.svg?style=flat-square&ignore_skipped=true)](https://gitlab.kilic.dev/libraries/listr2/-/commits/master) [![Version](https://img.shields.io/npm/v/listr2.svg?style=flat-square&logo=npm)](https://www.npmjs.com/package/listr2?activeTab=versions) [![Downloads](https://img.shields.io/npm/dm/listr2.svg?style=flat-square&logo=npm)](https://www.npmjs.com/package/listr2) [![Size](https://img.shields.io/bundlephobia/min/listr2?style=flat-square&logo=npm)](https://www.npmjs.com/package/listr2) [![Dependencies](https://img.shields.io/librariesio/release/npm/listr2?style=flat-square&logo=npm)](https://www.npmjs.com/package/listr2?activeTab=dependencies) [![codecov](https://codecov.io/gh/listr2/listr2/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/listr2/listr2)

[![github sponsors](https://img.shields.io/github/sponsors/cenk1cenk2?style=flat-square&logo=github)](https://github.com/sponsors/cenk1cenk2) [![opencollective](https://img.shields.io/opencollective/sponsors/listr2?label=open%20collective&logo=opencollective)](https://opencollective.com/listr2)

**Create beautiful CLI interfaces via easy and logical to-implement task lists that feel alive and interactive.**

---

## Documentation

**[Read the documentation...](https://listr2.kilic.dev)**

You can find the documentation source code in [here](https://github.com/listr2/listr2/tree/master/docs).

## Demo

![Demo](https://media.githubusercontent.com/media/listr2/listr2/master/examples/renderer-default.gif)

## Packages

[`listr2`](https://github.com/listr2/listr2/tree/master/packages/listr2)

### Extensions

- [`@listr2/manager`](https://github.com/listr2/listr2/tree/master/packages/manager)

### Prompt Adapters

- [`@listr2/prompt-adapter-enquirer`](https://github.com/listr2/listr2/tree/master/packages/prompt-adapter-enquirer)

- [`@listr2/prompt-adapter-inquirer`](https://github.com/listr2/listr2/tree/master/packages/prompt-adapter-inquirer)

## Examples

You can find the examples [here](https://github.com/listr2/listr2/tree/master/examples).