Virtus Cloud CLI Command Reference

The Virtus Cloud CLI exposes a rich set of commands for deploying applications, managing their lifecycle, and authenticating your session. Every command follows the pattern virtuscloud COMMAND [flags]. This page documents all available commands with their exact syntax and expected terminal output so you always know what to expect.

Primary Commands

Primary commands operate at the account and project level. Use them to authenticate, package your project, and upload it to Virtus Cloud.

Print a summary of all available commands and global flags.

virtuscloud help

Output

A command line application to manage your VirtusCloud applications

Usage:
  virtuscloud COMMAND [flags]
  virtuscloud [command]

Available Commands:
  app         Do some actions with your applications
  auth        Manage your authentication with VirtusCloud
  backup      Manage your backups
  commit      Commit your application to VirtusCloud
  help        Help about any command
  upload      Upload your application to VirtusCloud
  zip         Zip the current folder

Flags:
  -h, --help      help for virtuscloud
  -v, --version   Print CLI version

Use "virtuscloud [command] --help" for more information about a command.

Authenticate the CLI with your Virtus Cloud API key. You will be prompted to enter your token interactively, or you can supply it directly with --token.

virtuscloud auth login

Insert your square cloud api token

Your API Token:
> Insert your square cloud api token

Output

Your API Token has successfuly changed! You are now logged in a <username>
With great power comes great responsibility!

To authenticate non-interactively:

virtuscloud auth login --token=<your-api-key>

Use the --token flag in CI/CD pipelines to avoid interactive prompts.

Print the username associated with your currently active API token.

virtuscloud auth whoami

Output

Currently logged as <username>

Commit your local application source to Virtus Cloud. Run this command from your project directory.

virtuscloud commit

Output

✓ Your source has successfuly commited to VirtusCloud

Compress the current directory into a .zip archive. The archive is named after the current folder.

virtuscloud zip

Output

✓ Your source has successfuly zipped to documentation.zip

Upload your application to Virtus Cloud. This command packages and deploys the contents of your current directory.

virtuscloud upload

Output

 ✓ Your application has been uploaded

App Commands

App commands let you manage the full lifecycle of your deployed applications — from listing and monitoring to starting, stopping, and deleting them.

Print the help menu for the app subcommand group, showing all available sub-commands.

virtuscloud app

Output

Do some actions with your applications

Usage:
  virtuscloud app [flags]
  virtuscloud app [command]

Available Commands:
  backup      Create a backup of you application
  commit      Commit your application to VirtusCloud
  delete      Delete your application
  list        List all your applications
  logs        See your application logs
  restart     Restart your application
  start       Start your application
  status      Show the status of your application
  stop        Stop your application
  upload      Upload your application to VirtusCloud

Flags:
  -h, --help   help for app

Use "virtuscloud app [command] --help" for more information about a command.

List all applications deployed to your Virtus Cloud account, including their IDs, memory allocation, cluster, language runtime, and website flag.

virtuscloud app list

Output

NAME                             App ID                              MEMORY    CLUSTER        LANG          WEBSITE
Community Bot                    5bbd020326ee4692aba43e0ca0a75454    1024mb    fl-micron-1    javascript    false
Management Bot                   5241e2ae060a4735ba672dd4abb7099b    1024mb    fl-micron-2    javascript    false
Eval Bot Test                    7845e3b8683a4cb7a323656c09fdafce    1024mb    fl-micron-4    javascript    false
Config Web                       9b72fc4efc7748da9c69fe21daab18f4    2048mb    fl-micron-2    javascript    true
Proxy System                     a23d130fcc9d4be288ae4599a4292c32    3096mb    fl-micron-1    javascript    true
Portfolio                        441fa128793q47adbb7519536eb6f9bc    2048mb    fl-micron-1    static        true

Stream the live logs for a specific application. You are prompted to select or specify the target app.

virtuscloud app logs

Start a stopped application.

virtuscloud app start

Stop a running application without deleting it.

virtuscloud app stop

Restart a running application. Use this after configuration changes that require a full restart.

virtuscloud app restart

Display the current status of a specific application, including whether it is running, stopped, or in an error state.

virtuscloud app status

Permanently delete an application from your Virtus Cloud account.

virtuscloud app delete

This action is irreversible. The application and all associated data will be permanently removed. Create a backup first if you need to preserve your data.

Create a backup of your application’s current state. Use this before making significant changes or before deleting an app.

virtuscloud app backup

Commit your local source code to a specific deployed application.

virtuscloud app commit

Upload and deploy a new version of a specific application.

virtuscloud app upload

Getting Help for Any Command

Every command supports the -h / --help flag. Run it at any level to see the full usage details for that command:

virtuscloud app --help
virtuscloud auth --help
virtuscloud upload --help

​Primary Commands

​App Commands

​Getting Help for Any Command

Primary Commands

App Commands

Getting Help for Any Command