Mustard

KO | EN

gitlite — search

#javascript #react #llm #golang #android #machine-learning #docker #macos #java #awesome #vue #pytorch #openai #mcp

(★ 40)

IoC & Native ES Decorator based command-line app builder.

Mustard Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

![npm dev dependency version](https://img.shields.io/npm/dependency-version/mustard-cli/peer/typescript)
![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/LinbuduLab/Mustard/workflow.yml)

![GitHub package.json version (subfolder of monorepo)](https://img.shields.io/github/package-json/v/LinbuduLab/Mustard?filename=packages%2Fmustard-cli%2Fpackage.json)
![npm bundle size](https://img.shields.io/bundlephobia/minzip/mustard-cli)
[![codecov](https://codecov.io/gh/LinbuduLab/Mustard/branch/main/graph/badge.svg?token=ceNVnMTgmM)](https://codecov.io/gh/LinbuduLab/Mustard)

IoC & [Native ECMAScript Decorator](https://github.com/tc39/proposal-decorators) based command line app builder.

## Requires

- **Node.js >= 16.0.0**
- **TypeScript >= 5.0.0**

## Features

- Born to be type safe
- Nest command support
- Validator support by [Zod](https://github.com/colinhacks/zod)
- Automatic usage info generation
- Build decoupled applications using IoC concepts
- Essential built-in utils for CLI app

## Getting Started

- [Documentation](https://mustard-cli.netlify.app/)

```bash
$ pnpx create-mustard-app
```

Sample with root command only:

```typescript
import { MustardFactory, MustardUtils } from "mustard-cli";
import { RootCommand, App, Input } from "mustard-cli/decorator";
import { CommandStruct, MustardApp } from "mustard-cli/cli";

@RootCommand()
class RootCommandHandle implements CommandStruct {
  @Input()
  public name: string = "Harold";

public run(): void {
    console.log(`Hi, ${this.name}`);
  }
}

@App({
  name: "hi",
  commands: [RootCommandHandle],
})
class Project implements MustardApp {}

MustardFactory.init(Project).start();
```

```bash
$ hi
# Hi, Harold
$ hi John
# Hi, John
```

Sample with root command and sub commands:

```typescript
import { MustardFactory } from "mustard-cli";
import {
  Command,
  RootCommand,
  Option,
  VariadicOption,
  App,
  Input,
} from "mustard-cli/decorator";
import { Validator } from "mustard-cli/validator";
import { CommandStruct, MustardApp } from "mustard-cli/cli";

import path from "path";

@RootCommand()
class RootCommandHandle implements CommandStruct {
  @Option("m")
  public msg = "default value of msg";

public run(): void {
    console.log(`Root command executed with: msg: ${this.msg}`);
  }
}

@Command("update", "u", "update project dependencies")
class UpdateCommand implements CommandStruct {
  @Option("depth", "depth of packages to update", Validator.Number().Gte(1))
  public depth = 10;

@Option(Validator.Boolean())
  public dry = false;

@Option({ name: "target", alias: "t" })
  public targetOption: string;

@Input()
  public input: string[] = [];

@VariadicOption()
  public packages: string[] = [];

public run(): void {
    console.log(
      `Update command executed with: depth: ${this.depth}, dry: ${
        this.dry
      }, targetOption: ${this.targetOption}, input: ${JSON.stringify(
        this.input
      )}, packages: ${JSON.stringify(this.packages)}`
    );
  }
}

@App({
  name: "mm",
  commands: [RootCommandHandle, UpdateCommand],
  configurations: {
    allowUnknownOptions: true,
    enableVersion: require(path.resolve("./package.json")).version,
  },
})
class Project implements MustardApp {
  onStart() {}

onComplete() {}
}

MustardFactory.init(Project).start();
```

```bash
$ mm
# Root command executed with: msg: default value of msg
$ mm -m=hello
# Root command executed with: msg: hello
$ mm update
# Update command executed with: depth: 10, dry: false, targetOption: undefined, input: [], packages: []
$ mm update --depth=1 --target=dep --packages p1 p2 p3
# Update command executed with: depth: 1, dry: false, targetOption: dep, input: [], packages: ["p1","p2","p3"]
$ mm update p1 p2 p3 -t=dev
# Update command executed with: depth: 10, dry: false, targetOption: dev, input: ["p1","p2","p3"], packages: []
```

## Samples

You can find more samples [Here](packages/sample/samples/).

## License

[MIT](LICENSE)

Mustard

Mustard Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Mustard

Mustard Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README