File: overview.md

package info (click to toggle)
node-clipanion 3.2.1%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,232 kB
  • sloc: javascript: 75; makefile: 2
file content (17 lines) | stat: -rw-r--r-- 983 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
---
id: overview
title: Overview
slug: /
---

The idea behind Clipanion is to provide a CLI framework that won't make you hate CLIs. In particular, it means that Clipanion wants to be:

- **Correct**, with consistent and predictable behaviors regardless of your option definitions.
- **Full-featured**, with no need to write custom code to support for specific CLI patterns.
- **Type-safe**, with no risks that your application will silently rely on out-of-sync options.

It also has a few non-goals:

- We don't care about being **modular**. Given that we intend to be full-featured, it doesn't make sense to publish things under different package names. Clipanion will always be available as just `clipanion`.

- We won't provide **domain-specific languages (DSL)**. Once upon a time Clipanion actually worked like this, using a "natural" language to declare commands, but over time it became clear that we were merely fighting JavaScript, losing many useful tooling integrations.