Cavrnus Platform CLI Project
$ npm install -g @cavrnus/cli
$ cavcli COMMAND
running command...
$ cavcli (--version)
@cavrnus/cli/0.5.6 win32-x64 node-v18.20.4
$ cavcli --help [COMMAND]
USAGE
$ cavcli COMMAND
...cavcli basecommandcavcli help [COMMAND]cavcli logincavcli messagescavcli newcavcli pluginscavcli plugins:install PLUGIN...cavcli plugins:inspect PLUGIN...cavcli plugins:install PLUGIN...cavcli plugins:link PLUGINcavcli plugins:uninstall PLUGIN...cavcli plugins:uninstall PLUGIN...cavcli plugins:uninstall PLUGIN...cavcli plugins:updatecavcli profilecavcli roomclonecavcli roomlockcavcli scriptdeploy [SCRIPTPROJECTPATH] [MODULENAME] [MODULEVERSION]cavcli scriptdeployto [SCRIPTPROJECTPATH] [MODULENAME] [MODULEVERSION]cavcli scriptenv [ROOM] [EXCEPTTHISMODULE]cavcli scriptenvall [EXCEPTTHISMODULE]cavcli uploadfoldercavcli whitelabeldeploy [FILE]
USAGE
$ cavcli basecommand
See code: src/commands/basecommand.ts
Display help for cavcli.
USAGE
$ cavcli help [COMMAND...] [-n]
ARGUMENTS
COMMAND... Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for cavcli.
See code: @oclif/plugin-help
Log-in to Cavrnus
USAGE
$ cavcli login [-s]
FLAGS
-s, --server Also allow updating the target api server
DESCRIPTION
Log-in to Cavrnus
EXAMPLES
$ cavcli login
See code: src/commands/login.ts
Extract all chats and transcriptions from a Cavrnus space and write them to stdout as either csv or text.
USAGE
$ cavcli messages [-i <value>] [-o txt|csv] [-t] [-c] [-l <value>...]
FLAGS
-c, --nochat Remove chat type messages from the output
-i, --inroom=<value> Source room name, can be a partial match, case is not checked.
-l, --langs=<value>... Add a language code to extract, if the journal had translated into that language.
-o, --format=<option> Output format
<options: txt|csv>
-t, --notranscription Remove transcription type messages from the output
DESCRIPTION
Extract all chats and transcriptions from a Cavrnus space and write them to stdout as either csv or text.
EXAMPLES
$ cavcli messages
See code: src/commands/messages.ts
Create a new holoscript project template.
USAGE
$ cavcli new [-d]
FLAGS
-d, --dev Use prerelease/dev template and dependencies
DESCRIPTION
Create a new holoscript project template.
EXAMPLES
$ cavcli new
See code: src/commands/new.ts
List installed plugins.
USAGE
$ cavcli plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ cavcli plugins
See code: @oclif/plugin-plugins
Installs a plugin into the CLI.
USAGE
$ cavcli plugins:add plugins:install PLUGIN...
ARGUMENTS
PLUGIN... Plugin to install.
FLAGS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Installs a plugin into the CLI.
Can be installed from npm or a git url.
Installation of a user-installed plugin will override a core plugin.
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
the CLI without the need to patch and update the whole CLI.
ALIASES
$ cavcli plugins:add
EXAMPLES
$ cavcli plugins:install myplugin
$ cavcli plugins:install https://github.com/someuser/someplugin
$ cavcli plugins:install someuser/someplugin
Displays installation properties of a plugin.
USAGE
$ cavcli plugins:inspect PLUGIN...
ARGUMENTS
PLUGIN... [default: .] Plugin to inspect.
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Displays installation properties of a plugin.
EXAMPLES
$ cavcli plugins:inspect myplugin
See code: @oclif/plugin-plugins
Installs a plugin into the CLI.
USAGE
$ cavcli plugins:install PLUGIN...
ARGUMENTS
PLUGIN... Plugin to install.
FLAGS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Installs a plugin into the CLI.
Can be installed from npm or a git url.
Installation of a user-installed plugin will override a core plugin.
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
the CLI without the need to patch and update the whole CLI.
ALIASES
$ cavcli plugins:add
EXAMPLES
$ cavcli plugins:install myplugin
$ cavcli plugins:install https://github.com/someuser/someplugin
$ cavcli plugins:install someuser/someplugin
See code: @oclif/plugin-plugins
Links a plugin into the CLI for development.
USAGE
$ cavcli plugins:link PLUGIN
ARGUMENTS
PATH [default: .] path to plugin
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Links a plugin into the CLI for development.
Installation of a linked plugin will override a user-installed or core plugin.
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
command will override the user-installed or core plugin implementation. This is useful for development work.
EXAMPLES
$ cavcli plugins:link myplugin
See code: @oclif/plugin-plugins
Removes a plugin from the CLI.
USAGE
$ cavcli plugins:remove plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ cavcli plugins:unlink
$ cavcli plugins:remove
Removes a plugin from the CLI.
USAGE
$ cavcli plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ cavcli plugins:unlink
$ cavcli plugins:remove
See code: @oclif/plugin-plugins
Removes a plugin from the CLI.
USAGE
$ cavcli plugins:unlink plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ cavcli plugins:unlink
$ cavcli plugins:remove
Update installed plugins.
USAGE
$ cavcli plugins:update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
See code: @oclif/plugin-plugins
Emit logged in profile info.
USAGE
$ cavcli profile
DESCRIPTION
Emit logged in profile info.
EXAMPLES
$ cavcli profile
See code: src/commands/profile.ts
Copy a room
USAGE
$ cavcli roomclone [-i <value>] [-n <value>]
FLAGS
-i, --inroom=<value> Source room name, can be a partial match, case is not checked.
-n, --name=<value> Name of new room
DESCRIPTION
Copy a room
EXAMPLES
$ cavcli roomclone
See code: src/commands/roomclone.ts
Lock all objects in the provide or selected room
USAGE
$ cavcli roomlock [-i <value>]
FLAGS
-i, --inroom=<value> Source room name, can be a partial match, case is not checked.
DESCRIPTION
Lock all objects in the provide or selected room
EXAMPLES
$ cavcli roomlock
See code: src/commands/roomlock.ts
Upload a new or updated holoscript, and assign it to a designated testing room, and remove any old version of the script from that room.
USAGE
$ cavcli scriptdeploy [SCRIPTPROJECTPATH] [MODULENAME] [MODULEVERSION] [-r <value>]
FLAGS
-r, --room=<value> Room name to which to add the new script
DESCRIPTION
Upload a new or updated holoscript, and assign it to a designated testing room, and remove any old version of the
script from that room.
EXAMPLES
$ cavcli scriptdeploy
See code: src/commands/scriptdeploy.ts
Upload a new or updated holoscript, and assign it to a designated testing room, and remove any old version of the script from that room.
USAGE
$ cavcli scriptdeployto [SCRIPTPROJECTPATH] [MODULENAME] [MODULEVERSION] [-s]
FLAGS
-s, --save After selecting the room, set the selected room as the default target for deploy.
DESCRIPTION
Upload a new or updated holoscript, and assign it to a designated testing room, and remove any old version of the
script from that room.
EXAMPLES
$ cavcli scriptdeployto
See code: src/commands/scriptdeployto.ts
Download all scripts running in a provided Cavrnus room, so that they can be imported as they would running in Cavrnus
USAGE
$ cavcli scriptenv [ROOM] [EXCEPTTHISMODULE]
DESCRIPTION
Download all scripts running in a provided Cavrnus room, so that they can be imported as they would running in Cavrnus
EXAMPLES
$ cavcli scriptenv
See code: src/commands/scriptenv.ts
Download all scripts available in the user account, so that they can be imported as they would running in Cavrnus
USAGE
$ cavcli scriptenvall [EXCEPTTHISMODULE]
DESCRIPTION
Download all scripts available in the user account, so that they can be imported as they would running in Cavrnus
EXAMPLES
$ cavcli scriptenvall
See code: src/commands/scriptenvall.ts
Select a folder to upload all .holo files in it to your logged in Cavrnus account
USAGE
$ cavcli uploadfolder
DESCRIPTION
Select a folder to upload all .holo files in it to your logged in Cavrnus account
EXAMPLES
$ cavcli uploadfolder
See code: src/commands/uploadfolder.ts
When run, package all contents in a directory into a zip, and upload it to your Cavrnus account as a white-label package. Requires customer-administrator privileges.
USAGE
$ cavcli whitelabeldeploy [FILE]
DESCRIPTION
When run, package all contents in a directory into a zip, and upload it to your Cavrnus account as a white-label
package. Requires customer-administrator privileges.
EXAMPLES
$ cavcli whitelabeldeploy
See code: src/commands/whitelabeldeploy.ts