Help and version commands #1

almereyda commented 2023年06月30日 16:16:44 +02:00 (Migrated from github.com)

When using the Lume CLI, I would like to be able to check which commands are available, and from which version I'm running.

Common conventions for CLI tools are to make these functions available with --help/-h and --version/-v flags. In other conventions, these functionalities are implemented by triggering commands, such as help or version.

It could be nice, if the Lume CLI would support basic implementations for both.

Filing this here, because this is the CLI wrapper for the original command.

References:

• Command line usage - Lume
• lume/cli.ts at master · lumeland/lume · GitHub
• https://github.com/lumeland/lume/issues/232

When using the Lume CLI, I would like to be able to check which commands are available, and from which version I'm running. Common conventions for CLI tools are to make these functions available with `--help`/`-h` and `--version`/`-v` flags. In other conventions, these functionalities are implemented by triggering commands, such as `help` or `version`. It could be nice, if the Lume CLI would support basic implementations for both. Filing this here, because this is the CLI wrapper for the original command. References: * [Command line usage - Lume](https://lume.land/docs/overview/command-line/) * [lume/cli.ts at master · lumeland/lume · GitHub](https://github.com/lumeland/lume/blob/master/cli.ts) * https://github.com/lumeland/lume/issues/232

oscarotero commented 2023年06月30日 17:30:00 +02:00

Ok, it makes sense.

Lume CLI is just a wrapper to deno task lume. It means that if you run lume --version it runs deno task lume --version and returns the version of Lume used in your project (not the version of Lume CLI). And the same happens to lume -h.

But it's true that the CLI fails if lume task doesn't exist in the current directory. Maybe in this case the error should be catched and show some helpful information.

Ok, it makes sense. Lume CLI [is just a wrapper to `deno task lume`](https://github.com/lumeland/cli/blob/main/mod.ts#L21). It means that if you run `lume --version` it runs `deno task lume --version` and returns the version of Lume used in your project (not the version of Lume CLI). And the same happens to `lume -h`. But it's true that the CLI fails if `lume` task doesn't exist in the current directory. Maybe in this case the error should be catched and show some helpful information.