From f2fffa8a2677ab5b73a431bd43794998be113b01 Mon Sep 17 00:00:00 2001 From: wss-git Date: Thu, 10 Jun 2021 09:37:48 +0800 Subject: [PATCH] feat: help --- src/common/help.ts | 37 ++++++++++++++++++++++++++----------- src/index.ts | 1 - 2 files changed, 26 insertions(+), 12 deletions(-) diff --git a/src/common/help.ts b/src/common/help.ts index 00b3eef..bc57c2d 100644 --- a/src/common/help.ts +++ b/src/common/help.ts @@ -1,11 +1,11 @@ export default [ { - header: 'Description', - content: 'Remote Invoke', + header: 'Invoke', + content: 'Invoke/trigger online functions.', }, { header: 'Usage', - content: '$ fc-remote-invoke invoke ', + content: '$ s invoke ', }, { header: 'Options', @@ -36,17 +36,17 @@ export default [ }, { name: 'region', - description: 'Pass in region in cli mode', + description: 'Specify region in cli mode', type: String, }, { name: 'service-name', - description: 'Pass in service name in cli mode', + description: 'Specify service name in cli mode', type: String, }, { name: 'function-name', - description: 'Pass in function name in cli mode', + description: 'Specify function name in cli mode', type: String, }, ], @@ -54,9 +54,15 @@ export default [ { header: 'Global Options', optionList: [ + { + name: 'access', + description: 'Specify key alias.', + alias: 'a', + type: Boolean, + }, { name: 'help', - description: 'fc-remote-invoke help for command', + description: 'fc-remote-invoke help for command.', alias: 'h', type: Boolean, }, @@ -71,11 +77,20 @@ export default [ ], }, { - header: 'Examples with Cli', + header: 'Examples with CLI', content: [ - '$ s cli fc-remote-invoke invoke --region * --service-name * --function-name * --event [payload]', - '$ s cli fc-remote-invoke invoke --region * --service-name * --function-name * --event-file [path]', - '$ s cli fc-remote-invoke invoke --region * --service-name * --function-name * --event-stdin', + { + example: '$ s cli fc-remote-invoke invoke --region * --service-name * --function-name * --event [payload]', + }, + { + example: '$ s cli fc-remote-invoke invoke --region * --service-name * --function-name * --event-file [path]', + }, + { + example: '$ s cli fc-remote-invoke invoke --region * --service-name * --function-name * --event-stdin', + }, + { + example: 'You also can refer to the usage of fc-api and execute [s cli fc-api -h] for help. $ s cli fc-api invokeFunction -h', + }, ], }, ] \ No newline at end of file diff --git a/src/index.ts b/src/index.ts index 2fc170d..7737068 100644 --- a/src/index.ts +++ b/src/index.ts @@ -106,7 +106,6 @@ export default class FcRemoteInvoke { await this.report('fc-remote-invoke', 'invoke', credentials?.AccountID); if (isHelp) { - console.log('??'); core.help(HELP); return; }