drew-y/cliffy

NodeJS Framework for Interactive CLIs

cliffy's Issues

Feature suggestions

Been playing around with this for a CLI client before building a full on GUI. Had some ideas:

1. Tab support - command name or if sub command is next suggest that instead
2. Support single quotes for parameters - compute networkID 'a b c' currently gives a
   while compute networkID "a b c" gives an a b c
3. Function to display help for a certain command. For example if I use compute for as a namespace, if I type compute without a sub command following it, then I could show a list of sub commands help as if I typed help compute

Also curious, is it's possible to type while writing out text? I was playing with a CLI a few years ago and ran into that problem, but thinking it's probably some limitation in general. https://youtu.be/Q_E7ZFtoKY4 - I guess if that's the case then you wouldn't want to write anything to the console unless responding to a command.

[Request] Command Aliases

I may do a PR for this if I have time - I imagine this should be relatively simple?
Basically, my feature request just an array of aliases - set as a property on addCommand. Then, you can use these to execute the command as well as the normal trigger.

(The aliases wouldn't have to show up in help)

Unable to print color in the console

I am using chalk to print color, but it doesn't work with cliffy...

import { CLI } from "cliffy"
import chalk from "chalk"

const cli = new CLI()
  .setDelimiter(chalk.bold.blue("󰥭 "))
  .addCommand("run", {
    description: "Run somewhere",
    options: [{ label: "quickly", description: "Run quickly" }],
    parameters: ["destination"],
    action: (params, options) => {
      if (options.quickly) {
        console.log(chalk.yellow(`I ran to ${params.destination} quickly`))
        return
      }

      console.log(`I ran to ${params.destination}`)
    },
    subcommands: {
      to: {
        description: "Run to a destination",
        parameters: ["destination"],
        action: (params) => console.log(`I ran to ${params.destination}`),
      },
      from: {
        description: "Run from a destination",
        parameters: ["location"],
        action: (params) => console.log(`I ran from ${params.location}`),
      },
    },
  })
  .show()

How do I set an alias for the help command?

... if possible. Thanks!

Custom Error Messages and Header

I would like to start off that the tool is exactly what I needed only I miss out on the following:

• Customize Error (Command not Found)
• Maybe set a header as ASCII Art that will come back

[Question] Custom stdin/stdout ?

Hello,

Is it possible to set custom stdin & stdout streams in place of process.stdin & process.stdout ?

Thanks

console logs from outside of the CLI function are being ignored

Hi, Thanks for this great library.

I was implementing this in my project and noticed that only console.log() from inside the CLI function is displayed on the prompt. Is there any way to show logs from other files in the project?

[Question] Optional unordered key/value pairs ?

Hello,

How can I do the following using cliffy ?

--param2=foo --param1=bar --param3

Thanks

README uses deprecated `command`

The example in the README uses the deprecated command

  .command("run", {

and is missing a comma:

            }
            from: {

Commands take more arguments than supported

I just ran the example snippet and was surprised that this is accepted as input:

-->run foo bar

The command supports only one argument; if more are provided, I would expect that the CLI yields an error message that reminds the user of the correct syntax, but the CLI seems to ignore the superflous input silently and outputs this:

I ran to foo
-->

TS Error with option "noUnusedLocals"

With these tsc option "noUnusedLocals": true,
TSC give console errors:

node_modules/cliffy/src/index.ts(4,19): error TS6133: 'Parameter' is declared but its value is never read.
node_modules/cliffy/src/index.ts(10,7): error TS6133: 'columnify' is declared but its value is never read.