Ink-Router-Cli

ink-cli-parser

ink-cli-parser is a cli parser tool that is built just for
ink. You can pass in you custom ink help
component and error component.

Table Of Contents

- Getting Started
- Installation
- Usage
- Api reference

Getting Started

To install ink-cli-parser, ensure that you have Node.js >=10.
Install nodejs from here

$3

The easiest way to install ink-cli-parser is using NPM. If you have Node.js
installed, it is most likely that you have NPM installed as well

``
$ npm install ink-cli-parser
`

Usage

`tsx
import React, { FC } from "react";
import { Router, Switch, Command } from "ink-cli-router";
import { render, Text } from "ink";

const Create = () => {
return {"Creating file"};
};

const App: FC<{ any }> = () => {
return (


} />


);
};

render();
`

!ss

---

Api Reference

$3

$3

A that uses react context to keep the UI sync with the CLI argument
and falgs

argv: string[]
name?: string
description?: string

autoHelp?: boolean

$3

Renders only the command and flags that match the CLI arguments

$3

name: string
description?: string
component?: React.ReactElement

$3

name: string
alias: string
component?: React.ReactElement

description?: string


$3

#### useCli

Use this hook to get the CLI arguments

returns

`ts
{
command: string | undefined
arguments: string[] | undefined
flags: any
}
``