Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

flik

Package Overview
Dependencies
Maintainers
1
Versions
17
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

flik

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

  • 0.7.3
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
0
decreased by-100%
Maintainers
1
Weekly downloads
 
Created
Source

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:

npm install -D flik

With Yarn:

yarn add -D flik

⚡️ Usage

W.I.P.

Building your first command

It's easy!™️

Just give your command some options & define some functionality:

// 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

TODO

Putting it all together

// 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],
});

FAQs

Package last updated on 14 Apr 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc