# flik

> Build auto-documenting CLIs with an easy-to-use, declarative API.

Latest version **0.7.3** (published 2024-04-14) · MIT license · 0 weekly downloads

## Install

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

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.7.3 |
| Published | 2024-04-14 |
| First published | 2022-03-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 369.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Ian Smith |
| Maintainers | smithki |

## Links

- npm: https://www.npmjs.com/package/flik
- Repository: https://github.com/smithki/flik
- Homepage: https://github.com/smithki/flik#readme
- Issues: https://github.com/smithki/flik/issues
- npm.io page: https://npm.io/package/flik

## Recent versions

- 0.7.3 (latest) — 2024-04-14
- 0.7.2 — 2024-04-14
- 0.7.1 — 2023-05-30
- 0.7.0 — 2023-05-30
- 0.6.4 — 2023-05-09
- 0.6.3 — 2023-04-12
- 0.6.2 — 2023-04-09
- 0.6.1 — 2023-03-20
- 0.6.0 — 2023-03-20
- 0.5.1 — 2023-03-20
- 0.5.0 — 2023-03-20
- 0.4.2 — 2023-03-19
- 0.4.1 — 2023-03-19
- 0.4.0 — 2023-03-18
- 0.3.0 — 2022-08-31
- … 2 more at https://npm.io/package/flik/versions

## README

# `flik`

> Build auto-documenting CLIs with an easy-to-use, declarative API.

CLI frameworks in NodeJS are a dime-a-dozen. I built `flik` anyways because I didn't love any solution out there. In particular, there was always a little bit of jank when working with TypeScript. `flik` is built from the ground-up to make the best use of TypeScript possible, especially when working with the dynamic nature of CLIs.

## 🔗 Installation

With NPM:

```zsh
npm install -D flik
```

With Yarn:

```zsh
yarn add -D flik
```

## ⚡️ Usage

_W.I.P._

### Building your first command

_It's easy!™️_

Just give your command some options & define some functionality:

```ts
// my-cool-cli/commands/hello-world.ts
import { createCommand } from 'flik';

export const helloWorld = createCommand(
  {
    /**
     * The name of your command.
     */
    command: 'hello',

    /**
     *
     */
    description: "I'm just here to say hello",

    /**
     * Provide some example usage(s) for your command.
     *
     * These will be printed (with the binary & command automatically prefixed)
     * in help text if the user provides the `--help` flag.
     */
    examples: [
      'testing testing one two three'
    ],

    /**
     * Define some strongly-typed inputs for your command.
     * (We'll take a deeper look at this in the next section)
     */
    inputs: { flags, positionalArgs, variadicArg },

    /**
     *
     */
    cleanup: async () => {
      console.log('I log something when the process is stopped.');
    }
  },

  /**
   * Do some stuff with your command!
   */
  async () => {
    console.log('hello!');
  }
);
```

### Working with inputs

```ts
TODO
```

### Putting it all together

```ts
// my-cool-cli/index.ts
import { start } from 'flik';

import { helloWorld } from './commands/hello-world';

start({
  /**
   *
   */
  binaryName: 'my-cool-cli',

  /**
   *
   */
  version: '1.0.0',

  /**
   *
   */
  commands: [helloWorld],
});
```

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