CLIFrame

A simple CLI framework for building command-line applications in Node.js.

GETTING STARTED

Follow the steps to get started:

1. npm init -y
2. npm i -D typescript tsx @types/node making development easier.
3. Install cliFrame: npm i cliframe
4. Run npx cliframe init. This will generate cliframe.config.json file, which is a configuration file for cliFrame, and a folder named CLI by default.
5. In your root index.ts just import cliFrame method and call it.
6. The setup is almost complete. The only missing thing is your code that is how your cli would responed to different commands. The CLI folder is where your code lives.
   • To help you understand what you should keep and how to strcuture it, it is better to show you an example. Run npx cliframe generate-example
7. Now try running:
   • node index which will execute CLI/command.js
   • node index start which will exectue CLI/start/command.js
   • node index a b c which will execute CLI/a/b/c/command.js

Important to know: cliframe.config.json, index.ts|js and CLI folder should live at a same level.

Obviously to make your project a cli, you have to add "bin": {"mycli": "./index.js"} in your package.json. This way you can run index.js file with mycli instead of node index. node index start → mycli start

FILE SYSTEM CONVENTIONS

command.ts

It should export default a method. The method always get access to the props property, which is passed when it's called.

type Props = {
  argument: Record<string, string>;
  option: Record<string, boolean>;
  values: (string | number)[];
};

const command = (props: Props) => {
  console.log({
    msg: "command runs successfully",
    props,
  });
};

export default command;