talksuite-cli
Usage
INSTALL$ npm install -g @talksuite/talksuite-cli USAGE$ ts COMMANDrunning command...$ ts (-v|--version|version)talksuite-cli/x.y.z [ARCH] node-[NODEVERS]$ ts --help [COMMAND]
Commands
ts create-bot-template ORGID BOTID NAME
ts export-bots CONTENTDIR [ORGID] [BOTID]
ts export-content CONTENTDIR [ORGID] [PROJECTID]
ts help [COMMAND]
ts import-bots CONTENTDIR [ORGID] [BOTID]
ts import-content CONTENTDIR [ORGID] [PROJECTID] [REMOTEPROJECTID]
ts list-bots [ORGID]
ts list-dialogues [ORGID] [PROJECTID]
ts list-orgs
ts list-processes [ORGID]
ts list-projects [ORGID]
ts login [ENV] [EMAIL] [PASSWORD]
ts ludown-to-luis SOURCE OUT
ts luis-to-ludown SOURCE OUT
ts migrate-bot ORGID BOTID TEMPLATENAME
ts update-all-processes NAME HOURS MINUTES [ORGID]
ts validate-bots ORGID [BOTID]
ts create-bot-template ORGID BOTID NAME
Create a bot template to be used to ensure the correct configuration of all bots of the same type
USAGE
$ ts create-bot-template ORGID BOTID NAME
ARGUMENTS
ORGID org ID or name containing the bot to template
BOTID bot ID or name of the bot to template
NAME name of the template
See code: src\commands\create-bot-template.js
ts export-bots CONTENTDIR [ORGID] [BOTID]
Exports bots for backup or editing locally
USAGE
$ ts export-bots CONTENTDIR [ORGID] [BOTID]
ARGUMENTS
CONTENTDIR directory to output to
ORGID org ID or name
BOTID bot ID or name
See code: src\commands\export-bots.js
ts export-content CONTENTDIR [ORGID] [PROJECTID]
exports dialogues languages and projects to the local file system
USAGE
$ ts export-content CONTENTDIR [ORGID] [PROJECTID]
ARGUMENTS
CONTENTDIR directory to output to
ORGID org ID or name
PROJECTID project ID or name
OPTIONS
-g, --guid Stores in a human readable folder structure.
See code: src\commands\export-content.js
ts help [COMMAND]
display help for ts
USAGE
$ ts help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
ts import-bots CONTENTDIR [ORGID] [BOTID]
Imports bots from local files into talksuite
USAGE
$ ts import-bots CONTENTDIR [ORGID] [BOTID]
ARGUMENTS
CONTENTDIR directory to output to
ORGID org ID or name
BOTID bot ID or name
See code: src\commands\import-bots.js
ts import-content CONTENTDIR [ORGID] [PROJECTID] [REMOTEPROJECTID]
Imports the local copies of dialogues/languages and projects into talksuite
USAGE
$ ts import-content CONTENTDIR [ORGID] [PROJECTID] [REMOTEPROJECTID]
ARGUMENTS
CONTENTDIR directory to output to
ORGID org ID or name
PROJECTID org ID or name
REMOTEPROJECTID org ID or name
OPTIONS
-d, --delete Remove Content and projects that aren't being imported.
-i, --ignore ignore import order pre-checking.
See code: src\commands\import-content.js
ts list-bots [ORGID]
Lists the bots in an organisation talksuite.
USAGE
$ ts list-bots [ORGID]
ARGUMENTS
ORGID org ID
OPTIONS
-j, --json Returns in JSON format, not in a human readable form.
See code: src\commands\list-bots.js
ts list-dialogues [ORGID] [PROJECTID]
Lists the dialogues in an organisation talksuite.
USAGE
$ ts list-dialogues [ORGID] [PROJECTID]
ARGUMENTS
ORGID org ID or name
PROJECTID org ID or name
OPTIONS
-j, --json Returns in JSON format, not in a human readable form.
See code: src\commands\list-dialogues.js
ts list-orgs
Lists all your organisations in talksuite.
USAGE
$ ts list-orgs
OPTIONS
-j, --json Returns in JSON format, not in a human readable form.
See code: src\commands\list-orgs.js
ts list-processes [ORGID]
Lists the bots and their processes in an organisation talksuite.
USAGE
$ ts list-processes [ORGID]
ARGUMENTS
ORGID org ID
OPTIONS
-j, --json Returns in JSON format, not in a human readable form.
See code: src\commands\list-processes.js
ts list-projects [ORGID]
Lists the projects in a talksuite organisation.
USAGE
$ ts list-projects [ORGID]
ARGUMENTS
ORGID org ID
OPTIONS
-j, --json Returns in JSON format, not in a human readable form.
See code: src\commands\list-projects.js
ts login [ENV] [EMAIL] [PASSWORD]
login to talksuite to allow command line access
USAGE
$ ts login [ENV] [EMAIL] [PASSWORD]
ARGUMENTS
ENV [default: produks] base url to create http calls from (only applicable for internal talksuite development)
EMAIL Email that you would use to log into talksuite
PASSWORD password to use
See code: src\commands\login.js
ts ludown-to-luis SOURCE OUT
Convert a ludown file into a LUIS json file.
USAGE
$ ts ludown-to-luis SOURCE OUT
ARGUMENTS
SOURCE source file
OUT output file
See code: src\commands\ludown-to-luis.js
ts luis-to-ludown SOURCE OUT
Convert a luis json file into a ludown file.
USAGE
$ ts luis-to-ludown SOURCE OUT
ARGUMENTS
SOURCE source file
OUT output file
See code: src\commands\luis-to-ludown.js
ts migrate-bot ORGID BOTID TEMPLATENAME
Update a Bot from a template
USAGE
$ ts migrate-bot ORGID BOTID TEMPLATENAME
ARGUMENTS
ORGID org ID or name
BOTID bot ID or name
TEMPLATENAME bot ID or name
See code: src\commands\migrate-bot.js
ts update-all-processes NAME HOURS MINUTES [ORGID]
Update all processes on all bots in an org.
USAGE
$ ts update-all-processes NAME HOURS MINUTES [ORGID]
ARGUMENTS
NAME The name of the process
HOURS The hour when the process should trigger
MINUTES The minute when the process should trigger
ORGID org ID
OPTIONS
-j, --json Returns in JSON format, not in a human readable form.
See code: src\commands\update-all-processes.js
ts validate-bots ORGID [BOTID]
Compare a bot against its template showing any misconfigurations and potentially performing simple fixes
USAGE
$ ts validate-bots ORGID [BOTID]
ARGUMENTS
ORGID org ID or name
BOTID bot ID or name
OPTIONS
-u, --update update constants that are not valid against the templates
See code: src\commands\validate-bots.js
ts create-bot-template ORGID BOTID NAME
ts export-bots CONTENTDIR [ORGID] [BOTID]
ts export-content CONTENTDIR [ORGID] [PROJECTID]
ts help [COMMAND]
ts import-bots CONTENTDIR [ORGID] [BOTID]
ts import-content CONTENTDIR [ORGID] [PROJECTID] [REMOTEPROJECTID]
ts list-bots [ORGID]
ts list-dialogues [ORGID] [PROJECTID]
ts list-orgs
ts list-processes [ORGID]
ts list-projects [ORGID]
ts login [ENV] [EMAIL] [PASSWORD]
ts ludown-to-luis SOURCE OUT
ts luis-to-ludown SOURCE OUT
ts migrate-bot ORGID BOTID TEMPLATENAME
ts update-all-processes NAME HOURS MINUTES [ORGID]
ts validate-bots ORGID [BOTID]
ts create-bot-template ORGID BOTID NAME
Create a bot template to be used to ensure the correct configuration of all bots of the same type
USAGE
$ ts create-bot-template ORGID BOTID NAME
ARGUMENTS
ORGID org ID or name containing the bot to template
BOTID bot ID or name of the bot to template
NAME name of the template
See code: src\commands\create-bot-template.js
ts export-bots CONTENTDIR [ORGID] [BOTID]
Exports bots for backup or editing locally
USAGE
$ ts export-bots CONTENTDIR [ORGID] [BOTID]
ARGUMENTS
CONTENTDIR directory to output to
ORGID org ID or name
BOTID bot ID or name
See code: src\commands\export-bots.js
ts export-content CONTENTDIR [ORGID] [PROJECTID]
exports dialogues languages and projects to the local file system
USAGE
$ ts export-content CONTENTDIR [ORGID] [PROJECTID]
ARGUMENTS
CONTENTDIR directory to output to
ORGID org ID or name
PROJECTID project ID or name
OPTIONS
-g, --guid Stores in a human readable folder structure.
See code: src\commands\export-content.js
ts help [COMMAND]
display help for ts
USAGE
$ ts help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
ts import-bots CONTENTDIR [ORGID] [BOTID]
Imports bots from local files into talksuite
USAGE
$ ts import-bots CONTENTDIR [ORGID] [BOTID]
ARGUMENTS
CONTENTDIR directory to output to
ORGID org ID or name
BOTID bot ID or name
See code: src\commands\import-bots.js
ts import-content CONTENTDIR [ORGID] [PROJECTID] [REMOTEPROJECTID]
Imports the local copies of dialogues/languages and projects into talksuite
USAGE
$ ts import-content CONTENTDIR [ORGID] [PROJECTID] [REMOTEPROJECTID]
ARGUMENTS
CONTENTDIR directory to output to
ORGID org ID or name
PROJECTID org ID or name
REMOTEPROJECTID org ID or name
OPTIONS
-d, --delete Remove Content and projects that aren't being imported.
-i, --ignore ignore import order pre-checking.
See code: src\commands\import-content.js
ts list-bots [ORGID]
Lists the bots in an organisation talksuite.
USAGE
$ ts list-bots [ORGID]
ARGUMENTS
ORGID org ID
OPTIONS
-j, --json Returns in JSON format, not in a human readable form.
See code: src\commands\list-bots.js
ts list-dialogues [ORGID] [PROJECTID]
Lists the dialogues in an organisation talksuite.
USAGE
$ ts list-dialogues [ORGID] [PROJECTID]
ARGUMENTS
ORGID org ID or name
PROJECTID org ID or name
OPTIONS
-j, --json Returns in JSON format, not in a human readable form.
See code: src\commands\list-dialogues.js
ts list-orgs
Lists all your organisations in talksuite.
USAGE
$ ts list-orgs
OPTIONS
-j, --json Returns in JSON format, not in a human readable form.
See code: src\commands\list-orgs.js
ts list-processes [ORGID]
Lists the bots and their processes in an organisation talksuite.
USAGE
$ ts list-processes [ORGID]
ARGUMENTS
ORGID org ID
OPTIONS
-j, --json Returns in JSON format, not in a human readable form.
See code: src\commands\list-processes.js
ts list-projects [ORGID]
Lists the projects in a talksuite organisation.
USAGE
$ ts list-projects [ORGID]
ARGUMENTS
ORGID org ID
OPTIONS
-j, --json Returns in JSON format, not in a human readable form.
See code: src\commands\list-projects.js
ts login [ENV] [EMAIL] [PASSWORD]
login to talksuite to allow command line access
USAGE
$ ts login [ENV] [EMAIL] [PASSWORD]
ARGUMENTS
ENV [default: produks] base url to create http calls from (only applicable for internal talksuite development)
EMAIL Email that you would use to log into talksuite
PASSWORD password to use
See code: src\commands\login.js
Supported environments (last updated: 2019-07-26):
devuks
qauks
produks
preprodeuw
ts ludown-to-luis SOURCE OUT
Convert a ludown file into a LUIS json file.
USAGE
$ ts ludown-to-luis SOURCE OUT
ARGUMENTS
SOURCE source file
OUT output file
See code: src\commands\ludown-to-luis.js
ts luis-to-ludown SOURCE OUT
Convert a luis json file into a ludown file.
USAGE
$ ts luis-to-ludown SOURCE OUT
ARGUMENTS
SOURCE source file
OUT output file
See code: src\commands\luis-to-ludown.js
ts migrate-bot ORGID BOTID TEMPLATENAME
Move a Bot to a template
USAGE
$ ts migrate-bot ORGID BOTID TEMPLATENAME
ARGUMENTS
ORGID org ID or name
BOTID bot ID or name
TEMPLATENAME bot ID or name
See code: src\commands\migrate-bot.js
ts update-all-processes NAME HOURS MINUTES [ORGID]
Update all processes on all bots in an org.
USAGE
$ ts update-all-processes NAME HOURS MINUTES [ORGID]
ARGUMENTS
NAME The name of the process
HOURS The hour when the process should trigger
MINUTES The minute when the process should trigger
ORGID org ID
OPTIONS
-j, --json Returns in JSON format, not in a human readable form.
See code: src\commands\update-all-processes.js
ts validate-bots ORGID [BOTID]
Compare a bot against its template showing any misconfigurations and potentially performing simple fixes
USAGE
$ ts validate-bots ORGID [BOTID]
ARGUMENTS
ORGID org ID or name
BOTID bot ID or name
OPTIONS
-u, --update update constants that are not valid against the templates
See code: src\commands\validate-bots.js