From 9473e29f32ea47fc97212328eb86e7d342c0f152 Mon Sep 17 00:00:00 2001 From: TheoryOfNekomata Date: Thu, 14 Apr 2022 15:58:15 +0800 Subject: [PATCH] Improve help Add usage instructions and short description with the app. --- src/index.ts | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/src/index.ts b/src/index.ts index f74e18d..ebba7e9 100644 --- a/src/index.ts +++ b/src/index.ts @@ -9,6 +9,10 @@ import { void main( yargs + .scriptName('oblique') + .usage(`Oblique Strategies - Be creative, pick constraints, get to work. + +Usage: $0 [-c ] [-f] [-p ]`) .option('cards', { alias: 'c', description: "List of source for generating cards. Can have 'default', a pipe-delimited string starting with 'text:' or a URL starting with file:/// or http[s]://", @@ -53,5 +57,8 @@ void main( default: 'plain', }) .help() + .alias('h', 'help') + .alias('v', 'version') + .wrap(yargs.terminalWidth()) .parse(hideBin(process.argv)) as MainArgs, );