Skip to main content
Before you can deploy applications or run any account-level commands, you need to authenticate the Virtus Cloud CLI with your personal API key. Authentication stores your credentials locally so that every subsequent command runs under your account automatically. The process takes less than a minute.

​
Authenticate Your CLI

1

Get your API key from the dashboard

Open the Virtus Cloud Developer Dashboard and navigate to Account → Security. Generate a new API key or copy an existing one. Keep this key secure — it grants full access to your account.
2

Run the login command

In your terminal, run:
virtuscloud auth login
The CLI prompts you to enter your API key:
Your API Token:
> Insert your square cloud api token
Paste your API key and press Enter.
3

Confirm successful authentication

After you submit your key, the CLI confirms authentication with a success message:
Your API Token has successfuly changed! You are now logged in a <username>
With great power comes great responsibility!
You are now fully authenticated and ready to use all CLI commands.

​
Skip the Prompt with --token

If you prefer a non-interactive flow — for example, in CI/CD pipelines or automated scripts — pass your API key directly using the --token flag: 
virtuscloud auth login --token=<your-api-key>
Avoid hardcoding your API key in scripts that are committed to version control. Use environment variables or a secrets manager to keep your credentials safe.

​
Verify Your Session

At any time, you can confirm which account the CLI is authenticated to: 
virtuscloud auth whoami

Currently logged as <username>

​
Next Steps

With authentication complete, explore everything the CLI can do for your applications.

Commands Reference

Browse the full list of CLI commands for deploying and managing your applications.

Deploy Your Application

Use virtuscloud upload to push your first application to Virtus Cloud.