# animaux

> Javascript Library for CLI applications.

Latest version **0.1.2** (published 2025-09-15) · 0 weekly downloads

## Install

```sh
npm install animaux
pnpm add animaux
yarn add animaux
bun add animaux
```

## Health

**Score 55/100 (C)** — status: stable.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2025-09-15 |
| First published | 2023-01-12 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 29.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | do4ng |
| Keywords | cli, command-line-interface, arguments, parser, commander, argv |

## Links

- npm: https://www.npmjs.com/package/animaux
- Homepage: https://github.com/do4ng/animaux
- npm.io page: https://npm.io/package/animaux

## Dependencies (1)

- [colors](https://npm.io/package/colors.md) ^1.4.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 0.1.2 (latest) — 2025-09-15
- 0.1.1 — 2025-09-12
- 0.1.0 — 2025-02-26
- 0.0.4 — 2023-01-27
- 0.0.3 — 2023-01-12
- 0.0.2 — 2023-01-12
- 0.0.1 — 2023-01-12
- 0.0.0 — 2023-01-12

## README

# Animaux

Javascript Library for CLI applications.

## Feature

- Type-hint

![img](https://raw.githubusercontent.com/do4ng/animaux/refs/heads/main/screenshot-type-safe.png)

- Command and option definition

## Usage

#### Code

```js
#!/usr/bin/env node

const { program } = require('animaux');
const app = new program('greeting').version('1.0.0');

app
  .command('hello <name>')
  .describe('Greets the user')
  .option('--greet', 'Greet message', 'Hello')
  .option('--from', 'From', 'Cat')
  .action(({ args, options }) => {
    console.log(`${options.from} says "${options.greet}, ${args.name}"`);
  });

app.parse(process.argv.slice(2));
```

#### Result

```
$ greeting hello John
Cat says "Hello, John"

$ greeting hello John --from Dog --greet=Yo
Dog says "Yo, John"
```

#### `--help`

```
$ greeting --help

Usage
  $ greeting [command] [options]

Commands
  hello                Greets the user

Options (global)

Run '<command> --help' for more information on a command.
```

```
$ greeting build --help

Usage
  $ greeting hello <name>

Greets the user

Options (global)

Options (scoped)
  --greet              Greet message  (default: Hello)
  --from               From  (default: Cat)
```

## License

MIT

---
_Source: https://npm.io/package/animaux · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._