Skip to content
This repository was archived by the owner on Jan 15, 2025. It is now read-only.

Commit 24f8123

Browse files
author
JSpru
authored
Updating readme, fixurl script & cmd descriptions (#440)
* Updating readme, fixurl script & cmd descriptions * Update config set example cmd * Regenerate readme, fix backslashes * Update readmes
1 parent 206d069 commit 24f8123

File tree

22 files changed

+221
-266
lines changed

22 files changed

+221
-266
lines changed

‎packages/cli/README.md‎

Lines changed: 96 additions & 86 deletions
Large diffs are not rendered by default.

‎packages/config/src/commands/config/set/luis.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ export default class ConfigSetLuis extends Command {
1111
static description = 'Stores default LUIS application values in global config.'
1212

1313
static examples = [`
14-
$ bf luis:init --appId {APPLICATION_ID} --subscriptionKey {SUBSCRIPTION_KEY} --versionId {VERSION_ID} --region {REGION}
14+
$ bf config:set:luis --appId {APPLICATION_ID} --subscriptionKey {SUBSCRIPTION_KEY} --versionId {VERSION_ID} --region {REGION}
1515
`]
1616

1717
static flags: any = {

‎packages/luis/README.md‎

Lines changed: 74 additions & 129 deletions
Large diffs are not rendered by default.

‎packages/luis/package.json‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@microsoft/bf-luis-cli",
33
"version": "1.0.0",
4-
"bugs": "https://github.com/packages/bf-luis-cli/issues",
4+
"bugs": "https://github.com/microsoft/botframework-cli/issues",
55
"engines": {
66
"node": ">=8.0.0"
77
},
@@ -11,7 +11,7 @@
1111
"/oclif.manifest.json",
1212
"/yarn.lock"
1313
],
14-
"homepage": "https://github.com/packages/bf-luis-cli",
14+
"homepage": "https://github.com/microsoft/botframework-cli",
1515
"keywords": [
1616
"oclif-plugin"
1717
],
@@ -23,7 +23,7 @@
2323
"@oclif/plugin-help"
2424
]
2525
},
26-
"repository": "packages/bf-luis-cli",
26+
"repository": "https://github.com/microsoft/botframework-cli/tree/master/packages/luis",
2727
"scripts": {
2828
"postpack": "rimraf oclif.manifest.json",
2929
"posttest": "tslint -p test -t stylish",

‎packages/luis/src/commands/luis/application/create.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@ export default class LuisApplicationCreate extends Command {
1818
static flags: any = {
1919
help: flags.help({char: 'h'}),
2020
endpoint: flags.string({description: 'LUIS endpoint hostname'}),
21-
subscriptionKey: flags.string({description: 'LUIS cognitive services subscription key (mandatory, default: config:LUIS:subscriptionKey)'}),
22-
name: flags.string({description: 'Name of LUIS application'}),
21+
subscriptionKey: flags.string({description: '(required) LUIS cognitive services subscription key (default: config:LUIS:subscriptionKey)'}),
22+
name: flags.string({description: '(required) Name of LUIS application'}),
2323
culture: flags.string({description: 'Specify culture language (default: en-us)'}),
2424
description: flags.string({description: 'Description of LUIS application'}),
25-
versionId: flags.string({description: 'LUIS version Id. (mandatory, defaults to config:LUIS:versionId)'}),
25+
versionId: flags.string({description: '(required) LUIS version Id. (defaults to config:LUIS:versionId)'}),
2626
tokenizerVersion: flags.string({description: 'Version specifies how sentences are tokenized (optional). See also: https://aka.ms/luistokens'}),
2727
save: flags.boolean({description: 'Save configuration settings from imported app (appId & endpoint)'}),
2828
}

‎packages/luis/src/commands/luis/application/delete.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ export default class LuisApplicationDelete extends Command {
1717

1818
static flags: any = {
1919
help: flags.help({char: 'h'}),
20-
appId: flags.string({description: 'LUIS application Id (mandatory, defaults to config:LUIS:appId)'}),
20+
appId: flags.string({description: '(required) LUIS application Id (defaults to config:LUIS:appId)'}),
2121
endpoint: flags.string({description: 'LUIS endpoint hostname'}),
22-
subscriptionKey: flags.string({description: 'LUIS cognitive services subscription key (mandatory, default: config:LUIS:subscriptionKey)'}),
22+
subscriptionKey: flags.string({description: '(required) LUIS cognitive services subscription key (default: config:LUIS:subscriptionKey)'}),
2323
}
2424

2525
async run() {

‎packages/luis/src/commands/luis/application/import.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ export default class LuisApplicationImport extends Command {
1818
static flags: any = {
1919
help: flags.help({char: 'h'}),
2020
endpoint: flags.string({description: 'LUIS endpoint hostname'}),
21-
subscriptionKey: flags.string({description: 'LUIS cognitive services subscription key (mandatory, default: config:LUIS:subscriptionKey)'}),
21+
subscriptionKey: flags.string({description: '(required) LUIS cognitive services subscription key (default: config:LUIS:subscriptionKey)'}),
2222
name: flags.string({description: 'LUIS application name (optional)'}),
23-
in: flags.string({char: 'i', description: 'File path containing LUIS application contents, uses STDOUT if not specified (mandatory)'})
23+
in: flags.string({char: 'i', description: '(required) File path containing LUIS application contents, uses STDOUT if not specified'})
2424
}
2525

2626
async run() {

‎packages/luis/src/commands/luis/application/list.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ export default class LuisApplicationList extends Command {
1818
static flags: any = {
1919
help: flags.help({char: 'h'}),
2020
endpoint: flags.string({description: 'LUIS endpoint hostname'}),
21-
subscriptionKey: flags.string({description: 'LUIS cognitive services subscription key (mandatory, default: config:LUIS:subscriptionKey)'}),
21+
subscriptionKey: flags.string({description: '(required) LUIS cognitive services subscription key (default: config:LUIS:subscriptionKey)'}),
2222
out: flags.string({char: 'o', description: 'Output results to specified file in JSON format, otherwise prints to STDOUT (optional)'}),
2323
force: flags.boolean({char: 'f', description: 'If --out flag is provided with the path to an existing file, overwrites that file', default: false}),
2424
skip: flags.string({description: 'Number of entries to skip. Default: 0 (no skips)'}),

‎packages/luis/src/commands/luis/application/publish.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ export default class LuisApplicationPublish extends Command {
1717
static flags: any = {
1818
help: flags.help({char: 'h'}),
1919
endpoint: flags.string({description: 'LUIS endpoint hostname'}),
20-
subscriptionKey: flags.string({description: 'LUIS cognitive services subscription key (mandatory, default: config:LUIS:subscriptionKey)'}),
21-
appId: flags.string({description: 'LUIS application Id (mandatory, defaults to config:LUIS:appId)'}),
22-
versionId: flags.string({description: 'Version to publish (mandatory, defaults to config:LUIS:versionId)'}),
20+
subscriptionKey: flags.string({description: '(required) LUIS cognitive services subscription key (default: config:LUIS:subscriptionKey)'}),
21+
appId: flags.string({description: '(required) LUIS application Id (defaults to config:LUIS:appId)'}),
22+
versionId: flags.string({description: '(required) Version to publish (defaults to config:LUIS:versionId)'}),
2323
staging: flags.boolean({description: 'Publishes application version to Staging slot, otherwise publish to production (default: false)'}),
2424
direct: flags.boolean({description: 'Available only in direct version query. Do not publish to staging or production (default: false)'})
2525
}

‎packages/luis/src/commands/luis/application/query.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ export default class LuisApplicationQuery extends Command {
1717
static flags: any = {
1818
help: flags.help({char: 'h'}),
1919
endpoint: flags.string({description: 'LUIS endpoint hostname'}),
20-
subscriptionKey: flags.string({description: 'LUIS cognitive services subscription key (mandatory, default: config:LUIS:subscriptionKey)'}),
21-
appId: flags.string({description: 'LUIS application Id (mandatory, defaults to config:LUIS:appId)'}),
22-
query: flags.string({description: 'Query string to predict (mandatory)'}),
20+
subscriptionKey: flags.string({description: '(required) LUIS cognitive services subscription key (default: config:LUIS:subscriptionKey)'}),
21+
appId: flags.string({description: '(required) LUIS application Id (defaults to config:LUIS:appId)'}),
22+
query: flags.string({description: '(required) Query string to predict'}),
2323
staging: flags.boolean({description: 'Presence of flag targets the staging app, if no flag passed defaults to production'}),
2424
verbose: flags.boolean({description: 'Returns all intents, otherwise only top scoring intent. (default: false)'}),
2525
timezoneOffset: flags.string({description: 'Timezone offset for the location of the request in minutes (optional)'}),

0 commit comments

Comments
 (0)