# @cavrnus/cli

> Cavrnus API tools

Latest version **0.5.6** (published 2024-12-03) · ISC license · 0 weekly downloads

## Install

```sh
npm install @cavrnus/cli
pnpm add @cavrnus/cli
yarn add @cavrnus/cli
bun add @cavrnus/cli
```

Provides the command `cavcli`.

## Health

**Score 35/100 (D)** — status: maintenance-mode.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.5.6 |
| Published | 2024-12-03 |
| First published | 2022-05-19 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=12.0.0 |
| Dependencies | 12 |
| Unpacked size | 106.4 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Nick Gebbie |
| Maintainers | cavrnusdev |
| Keywords | oclif |

## Links

- npm: https://www.npmjs.com/package/@cavrnus/cli
- Repository: https://github.com/Cavrnus-Inc/cavrnus-cli
- Issues: https://github.com/Cavrnus-Inc/cavrnus-cli/issues
- npm.io page: https://npm.io/package/@cavrnus/cli

## Dependencies (12)

- [fs](https://npm.io/package/fs.md) ^0.0.1-security
- [ws](https://npm.io/package/ws.md) ^8.11.0
- [path](https://npm.io/package/path.md) ^0.12.7
- [jszip](https://npm.io/package/jszip.md) ^3.10.0
- [shelljs](https://npm.io/package/shelljs.md) ^0.8.5
- [fs-extra](https://npm.io/package/fs-extra.md) ^10.1.0
- [inquirer](https://npm.io/package/inquirer.md) ^8.2.4
- [@oclif/core](https://npm.io/package/@oclif/core.md) 1.20.2
- [@cavrnus/lib](https://npm.io/package/@cavrnus/lib.md) ^0.5.10
- [@oclif/plugin-help](https://npm.io/package/@oclif/plugin-help.md) 5.1.17
- [@oclif/plugin-plugins](https://npm.io/package/@oclif/plugin-plugins.md) 2.1.6
- [inquirer-select-directory](https://npm.io/package/inquirer-select-directory.md) ^1.2.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 0.5.6 (latest) — 2024-12-03
- 0.5.5 — 2024-11-13
- 0.5.4 — 2024-11-13
- 0.5.3 — 2024-11-13
- 0.5.2 — 2024-11-13
- 0.5.1 — 2024-11-13
- 0.5.0 — 2024-11-13
- 0.4.23 — 2024-01-17
- 0.4.22 — 2024-01-17
- 0.4.21 — 2023-11-10
- 0.4.20 — 2023-10-24
- 0.4.19 — 2023-10-11
- 0.4.18 — 2023-10-11
- 0.4.17 — 2023-08-29
- 0.4.16 — 2023-07-27
- … 83 more at https://npm.io/package/@cavrnus/cli/versions

## README

cavrnus-cli
=================

Cavrnus Platform CLI Project

<!-- toc -->
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->
# Usage
<!-- usage -->
```sh-session
$ 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
...
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`cavcli basecommand`](#cavcli-basecommand)
* [`cavcli help [COMMAND]`](#cavcli-help-command)
* [`cavcli login`](#cavcli-login)
* [`cavcli messages`](#cavcli-messages)
* [`cavcli new`](#cavcli-new)
* [`cavcli plugins`](#cavcli-plugins)
* [`cavcli plugins:install PLUGIN...`](#cavcli-pluginsinstall-plugin)
* [`cavcli plugins:inspect PLUGIN...`](#cavcli-pluginsinspect-plugin)
* [`cavcli plugins:install PLUGIN...`](#cavcli-pluginsinstall-plugin)
* [`cavcli plugins:link PLUGIN`](#cavcli-pluginslink-plugin)
* [`cavcli plugins:uninstall PLUGIN...`](#cavcli-pluginsuninstall-plugin)
* [`cavcli plugins:uninstall PLUGIN...`](#cavcli-pluginsuninstall-plugin)
* [`cavcli plugins:uninstall PLUGIN...`](#cavcli-pluginsuninstall-plugin)
* [`cavcli plugins:update`](#cavcli-pluginsupdate)
* [`cavcli profile`](#cavcli-profile)
* [`cavcli roomclone`](#cavcli-roomclone)
* [`cavcli roomlock`](#cavcli-roomlock)
* [`cavcli scriptdeploy [SCRIPTPROJECTPATH] [MODULENAME] [MODULEVERSION]`](#cavcli-scriptdeploy-scriptprojectpath-modulename-moduleversion)
* [`cavcli scriptdeployto [SCRIPTPROJECTPATH] [MODULENAME] [MODULEVERSION]`](#cavcli-scriptdeployto-scriptprojectpath-modulename-moduleversion)
* [`cavcli scriptenv [ROOM] [EXCEPTTHISMODULE]`](#cavcli-scriptenv-room-exceptthismodule)
* [`cavcli scriptenvall [EXCEPTTHISMODULE]`](#cavcli-scriptenvall-exceptthismodule)
* [`cavcli uploadfolder`](#cavcli-uploadfolder)
* [`cavcli whitelabeldeploy [FILE]`](#cavcli-whitelabeldeploy-file)

## `cavcli basecommand`

```
USAGE
  $ cavcli basecommand
```

_See code: [src/commands/basecommand.ts](https://github.com/Cavrnus-Inc/cavrnus-cli/blob/v0.5.6/src/commands/basecommand.ts)_

## `cavcli help [COMMAND]`

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](https://github.com/oclif/plugin-help/blob/v5.1.17/src/commands/help.ts)_

## `cavcli login`

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](https://github.com/Cavrnus-Inc/cavrnus-cli/blob/v0.5.6/src/commands/login.ts)_

## `cavcli messages`

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](https://github.com/Cavrnus-Inc/cavrnus-cli/blob/v0.5.6/src/commands/messages.ts)_

## `cavcli new`

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](https://github.com/Cavrnus-Inc/cavrnus-cli/blob/v0.5.6/src/commands/new.ts)_

## `cavcli plugins`

List installed plugins.

```
USAGE
  $ cavcli plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ cavcli plugins
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.1.6/src/commands/plugins/index.ts)_

## `cavcli plugins:install PLUGIN...`

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
```

## `cavcli plugins:inspect PLUGIN...`

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](https://github.com/oclif/plugin-plugins/blob/v2.1.6/src/commands/plugins/inspect.ts)_

## `cavcli plugins:install PLUGIN...`

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](https://github.com/oclif/plugin-plugins/blob/v2.1.6/src/commands/plugins/install.ts)_

## `cavcli plugins:link PLUGIN`

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](https://github.com/oclif/plugin-plugins/blob/v2.1.6/src/commands/plugins/link.ts)_

## `cavcli plugins:uninstall PLUGIN...`

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
```

## `cavcli plugins:uninstall PLUGIN...`

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](https://github.com/oclif/plugin-plugins/blob/v2.1.6/src/commands/plugins/uninstall.ts)_

## `cavcli plugins:uninstall PLUGIN...`

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
```

## `cavcli plugins:update`

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](https://github.com/oclif/plugin-plugins/blob/v2.1.6/src/commands/plugins/update.ts)_

## `cavcli profile`

Emit logged in profile info.

```
USAGE
  $ cavcli profile

DESCRIPTION
  Emit logged in profile info.

EXAMPLES
  $ cavcli profile
```

_See code: [src/commands/profile.ts](https://github.com/Cavrnus-Inc/cavrnus-cli/blob/v0.5.6/src/commands/profile.ts)_

## `cavcli roomclone`

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](https://github.com/Cavrnus-Inc/cavrnus-cli/blob/v0.5.6/src/commands/roomclone.ts)_

## `cavcli roomlock`

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](https://github.com/Cavrnus-Inc/cavrnus-cli/blob/v0.5.6/src/commands/roomlock.ts)_

## `cavcli scriptdeploy [SCRIPTPROJECTPATH] [MODULENAME] [MODULEVERSION]`

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](https://github.com/Cavrnus-Inc/cavrnus-cli/blob/v0.5.6/src/commands/scriptdeploy.ts)_

## `cavcli scriptdeployto [SCRIPTPROJECTPATH] [MODULENAME] [MODULEVERSION]`

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](https://github.com/Cavrnus-Inc/cavrnus-cli/blob/v0.5.6/src/commands/scriptdeployto.ts)_

## `cavcli scriptenv [ROOM] [EXCEPTTHISMODULE]`

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](https://github.com/Cavrnus-Inc/cavrnus-cli/blob/v0.5.6/src/commands/scriptenv.ts)_

## `cavcli scriptenvall [EXCEPTTHISMODULE]`

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](https://github.com/Cavrnus-Inc/cavrnus-cli/blob/v0.5.6/src/commands/scriptenvall.ts)_

## `cavcli uploadfolder`

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](https://github.com/Cavrnus-Inc/cavrnus-cli/blob/v0.5.6/src/commands/uploadfolder.ts)_

## `cavcli whitelabeldeploy [FILE]`

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](https://github.com/Cavrnus-Inc/cavrnus-cli/blob/v0.5.6/src/commands/whitelabeldeploy.ts)_
<!-- commandsstop -->

---
_Source: https://npm.io/package/@cavrnus/cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._