varitykit login and auth command

Varity TeamCore Contributors

Log in to Varity from the CLI using a deploy key from the developer portal. Authentication is required for deploying apps and managing domains.

Usage

# Top-level shortcut
varitykit login

# Or use the auth subcommand
varitykit auth login

Both commands do the same thing: prompt you for a deploy key and save it locally.

Prerequisites

You need a deploy key from the Varity developer portal:

Go to the developer portal

Open developer.store.varity.so/dashboard/settings in your browser.
Copy your deploy key

Open the Deploy keys tab and click Create deploy key, then copy the key. Either varitykit login or the VARITY_DEPLOY_KEY environment variable supplies it.
Run the login command
Terminal window
```
varitykit login
```
In an interactive terminal the CLI opens the settings page in your browser and asks you to paste the key (input is hidden for security). In CI or any non-interactive shell, pass the key instead: varitykit login --key <key>.
Verify you are logged in
Terminal window
```
varitykit auth status
```

Commands

varitykit login
# or
varitykit auth login

Example output:

  ╭─────────────────────────────────────────────────────╮
  │  Get your deploy key from the developer portal:     │
  │  https://developer.store.varity.so/dashboard/settings│
  ╰─────────────────────────────────────────────────────╯

  Opening https://developer.store.varity.so/dashboard/settings in your browser...
  (input will be hidden for security)

  Paste your deploy key: ********

  Deploy key saved securely.
  Logged in successfully!
  Configured: deploy key
  Run 'varitykit app deploy' to deploy.

If you are already logged in, the CLI will show your current key (masked) and ask if you want to replace it.

logout

Remove your saved credentials from this machine.

varitykit auth logout

This removes the deploy key from your local config file. You will need to run varitykit login again to deploy.

status

Show your current login status.

varitykit auth status

Example output when logged in:

  Logged in (key: vk_...7f2a)

Example output when not logged in:

  Not logged in.
  Run 'varitykit login' to connect your developer account.

Where Credentials Are Stored

Credentials are saved to ~/.varitykit/config.json with restricted file permissions:

Path	Permissions
`~/.varitykit/`	`700` (owner-only access)
`~/.varitykit/config.json`	`600` (owner-only read/write)

The config file holds one credential:

Key	Description
`deploy_key`	Your developer portal deploy key

When Is Authentication Required?

Command	Requires Login
`varitykit app deploy`	Yes
`varitykit app list`	Yes
`varitykit migrate`	Yes
`varitykit doctor`	No

Troubleshooting

“Not logged in” when deploying

Run varitykit login and paste your deploy key from the developer portal.

“Invalid deploy key”

Make sure you copied the full key from the developer portal Settings page. The key must be at least 10 characters long.

Credentials not persisting

Check that the CLI has write access to your home directory:

ls -la ~/.varitykit/

If the directory does not exist, varitykit login will create it automatically.

Next Steps

Deploy your app: Deploy to production
CLI Overview: All CLI commands
Quick Start: Complete tutorial

Managed Credentials: How Varity manages your credentials
Environment Variables: Required configuration