ViviScape.CLI · vs

Your workspace, from the shell.

The vs CLI scripts ViviScape Work from any terminal — bulk imports, scheduled reports, CI hooks and one-off queries. A global .NET 8 tool with a gh auth login-style browser sign-in, JSON output on every command, and every action logged as you. Requires a paid plan.

Overview REST API MCP server CLI

Install, sign in, and script your workspace

The vs CLI scripts your workspace from a shell — bulk imports, scheduled reports, CI hooks and one-off queries. It is a global .NET 8 tool with a browser-based login flow, and it requires a paid plan.

nuget.org/packages/ViviScape.CLI

Install

Requires the .NET 8 SDK (or newer).

# install globally
dotnet tool install -g ViviScape.CLI

# sign in — browser opens to work.viviscape.io
vs auth login

vs --help

# upgrade later
dotnet tool update -g ViviScape.CLI

If vs isn't found, ensure %USERPROFILE%\.dotnet\tools is on PATH and open a fresh terminal.

How auth works

Browser-based loopback flow — same pattern as gh auth login:

  1. vs auth login starts a local listener and opens work.viviscape.io/auth/cli/connect.
  2. The bridge page reads your ViviScape Work session and POSTs it back to the CLI.
  3. Credentials are stored in Windows Credential Manager (or ~/.viviscape/credentials.json on macOS/Linux, mode 600).

Override the host with VIVISCAPE_BASE_URL (defaults to https://work.viviscape.io).

Sample sessions

# list active companies as JSON, pipe through jq
$ vs companies list --format json | jq '.[].name'

# create a company
$ vs companies add --name "Beacon & Co." --tag enterprise

# open one in your browser
$ vs companies open cmp_4f81

Why a CLI?

  • Drop into CI pipelines for nightly automation
  • Pipe-friendly --format json on every command
  • Same identity as the web — every action audit-logged
  • Cross-platform: Windows, macOS, Linux

Script it once. Run it forever.

Same identity as the web app, same audit trail, pipe-friendly output.