How to Install and Log In to the Gavana CLI

Prerequisites

Node.js 20 or newer

For interactive use, the CLI can use browser OAuth. For unattended automation, create a least-privilege Agent Access token.

Steps

Step 1: Install the CLI

The repository contains the CLI package, but this help center does not treat npm publication as verified. If the public package is unavailable, use the source install only when you have repository access:


git clone https://gitlab.com/avada/gavana.ai.git
cd gavana.ai
npm install
npm run canvas:cli:install
command -v gavana
gavana --help

The older craftboard and craftboard-canvas commands remain available as compatibility aliases.

When @gavana/cli is publicly available, the install is:


npm install --global @gavana/cli

For the smallest interactive browser-authorized profile, use the CLI’s OAuth login and choose read-only when you only need inspection:


gavana auth login --read-only

For a non-interactive integration, use a scoped Agent Access token without putting it in shell history or process arguments:

Step 3: Log in with an Agent Access token

Use the command for your shell. Each version prompts without storing the token in shell history or exposing it in the process arguments.

zsh (the default shell on current macOS)


read -rs 'GAVANA_AGENT_TOKEN?Paste Agent Access token: '; printf '\n'; printf '%s' "$GAVANA_AGENT_TOKEN" | gavana auth login --base-url 'https://app.gavana.ai' --token-stdin; unset GAVANA_AGENT_TOKEN

Bash


read -rsp 'Paste Agent Access token: ' GAVANA_AGENT_TOKEN; printf '\n'; printf '%s' "$GAVANA_AGENT_TOKEN" | gavana auth login --base-url 'https://app.gavana.ai' --token-stdin; unset GAVANA_AGENT_TOKEN

PowerShell


$secureToken = Read-Host 'Paste Agent Access token' -AsSecureString
$token = [System.Net.NetworkCredential]::new('', $secureToken).Password
$token | gavana auth login --base-url 'https://app.gavana.ai' --token-stdin
Remove-Variable token, secureToken

Paste the token when prompted, then press Return. For local development, use --base-url http://localhost:3000 instead.

Step 4: Verify


gavana auth status

Reference

The CLI keeps its local profile private; do not copy it into a repository, chat, or support request.
Environment variables override saved config: GAVANA_BASE_URL, GAVANA_AGENT_TOKEN.
Existing ~/.config/craftboard/agent.json, CRAFTBOARD_* variables, and craftboard commands remain supported during the transition.
HTTPS is required for remote origins. Plain HTTP is only accepted for localhost, 127.0.0.1, or ::1.

Tips

Never paste a literal cba_… token directly into a shell command — use the stdin prompt above so it never lands in your shell history.
Use a distinct token per machine or client so you can revoke access individually.
Installing the CLI does not install the local MCP adapter. Follow the separate MCP setup guide when you need it.
Use gavana doctor when the local profile, connectivity, or installed capabilities need a diagnosis.