Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/activeviam/execli
Genenerate task running CLIs declaratively
https://github.com/activeviam/execli
cli exec listr task task-runner yargs
Last synced: 5 days ago
JSON representation
Genenerate task running CLIs declaratively
- Host: GitHub
- URL: https://github.com/activeviam/execli
- Owner: activeviam
- License: mit
- Created: 2020-04-13T22:01:03.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-02-21T23:10:35.000Z (over 1 year ago)
- Last Synced: 2024-04-24T09:25:43.048Z (7 months ago)
- Topics: cli, exec, listr, task, task-runner, yargs
- Language: TypeScript
- Size: 466 KB
- Stars: 7
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/execli)
# Execli
Generate task-oriented CLIs declaratively.
Powered by [listr2](https://www.npmjs.com/package/listr2) and [yargs](https://www.npmjs.com/package/yargs).
## Usage
### Example file
```typescript
// commands.ts
import { OptionsContext, Task, getCommand } from "execli";
const options = {
customFlag: {
boolean: true,
description: "A custom option",
},
} as const;
type DemoContext = OptionsContext;
const parentTask: Task = {
children: [
{
command: ["pwd"],
title: "Command task",
},
{
async run({ context: { customFlag }, exec }) {
if (customFlag) {
console.log("flag given");
} else {
await exec(["sleep", "1"]);
}
},
tags: ["regular"],
title: "Regular task",
},
{
children: [
{
command: ["curl", "https://example.com"],
tags: ["network"],
title: "Another command task",
},
{
command: ["touch", "file.txt"],
tags: ["filesystem"],
title: "Yet another command task",
},
],
title: "Nested task",
},
],
title: "Parent task",
};
export const demo = getCommand({
options,
task: parentTask,
});
```
This file is written in TypeScript to showcase the built-in types.
Compile it down to JavaScript to use it with the following commands.
### Running the CLI
```
$ execli run --help
execli run
Run the commands at the given path, forwarding the command line arguments after `--`.
Positionals:
path The path resolving to the file exporting the commands. [string] [required]
Options:
--help Show help [boolean]
```
```
$ execli run commands.js -- demo --help
execli demo
Parent task
Options:
--help Show help [boolean]
--customFlag A custom option [boolean]
--concurrency How many concurrent tasks should be executed at the same time.
0 means 1 task, 1 means as much as there are CPUs on the machine, 0.5 means half the CPUs, etc.
If 0, the verbose renderer will be used and the output of shell commands will be streamed to the terminal.
[number] [default: Use all the available CPUs.]
--dryRun Do not run tasks but show the shell commands that would have been run. [boolean] [default: false]
--from Skip tasks before the one with the given title (or title slug).
[choices: "Another command task", "Command task", "Nested task", "Parent task", "Regular task", "Yet another command task"]
--only Only run tasks with one of the given titles (or title slugs).
[array] [choices: "Another command task", "Command task", "Nested task", "Parent task", "Regular task", "Yet another command task"] [default: []]
--skip Skip tasks with one of the given titles (or title slugs).
[array] [choices: "Another command task", "Command task", "Nested task", "Parent task", "Regular task", "Yet another command task"] [default: []]
--tag Only run tasks with at least one of the given tags. [array] [choices: "filesystem", "network", "regular"] [default: []]
--until Skip tasks after the one with the given title (or title slug).
[choices: "Another command task", "Command task", "Nested task", "Parent task", "Regular task", "Yet another command task"]
```
```
$ execli run commands.js -- demo --dryRun
✔ Parent task [0.0s]
⚠ Command task ($ pwd)
↓ Skipped by --dryRun option
⚠ Regular task
↓ Skipped by --dryRun option
✔ Nested task [0.0s]
⚠ Another command task ($ curl https://example.com)
↓ Skipped by --dryRun option
⚠ Yet another command task ($ touch file.txt)
↓ Skipped by --dryRun option
```
### Compiling the CLI
```
$ execli compile --help
execli compile
Compile the commands at the given path to a single executable Node.js file, together with all the dependencies.
Positionals:
source The path resolving to the file exporting the commands. [string] [required]
target The path where the compiled Node.js file will be written to. [string] [required]
Options:
--help Show help [boolean]
```
```
$ execli compile commands.js cli.js
$ ./cli.js demo --debug --dryRun
❯ Parent task
❯ Command task
☒ Command task ($ pwd)
↓ Skipped by --dryRun option
❯ Regular task
↓ Skipped by --dryRun option
❯ Nested task
❯ Another command task
☒ Another command task ($ curl https://example.com)
↓ Skipped by --dryRun option
❯ Yet another command task
☒ Yet another command task ($ touch file.txt)
↓ Skipped by --dryRun option
✔ Nested task [0.0s]
✔ Parent task [0.0s]
```