Installation

Install the dcupl CLI globally to access it from any directory.

Prerequisites

Node.js 20.19.1+ - Check with node -v
npm, yarn, or pnpm - Package manager
dcupl Console account - Sign up if needed

Install

npm install -g @dcupl/cli

yarn global add @dcupl/cli

pnpm add -g @dcupl/cli

Verify the installation:

dcupl --version
# → @dcupl/cli/x.x.x (your installed version)

Authentication

dcupl login

This opens your browser to authenticate. After successful login, your credentials are stored locally.

Authentication Methods

Method	Use Case	Setup
Interactive login	Local development	`dcupl login`
API key	CI/CD pipelines	Environment variable
Project config	Per-project auth	`dcupl.config.json`

Using API Keys

For automated environments (CI/CD), use a CLI API key instead of interactive login:

Go to Console → Your Project → Settings → API Keys
Create a new key with type CLI API Key
Set the environment variable:

export DCUPL_API_KEY=your-cli-api-key

The CLI automatically uses DCUPL_API_KEY when available.

Verify Setup

Check that everything works:

# Show current authentication status
dcupl whoami

# List accessible projects
dcupl projects list

Updating

Update to the latest version:

npm update -g @dcupl/cli

yarn global upgrade @dcupl/cli

pnpm update -g @dcupl/cli

Uninstall

Remove the CLI:

npm uninstall -g @dcupl/cli

yarn global remove @dcupl/cli

pnpm remove -g @dcupl/cli

Troubleshooting

Command not found

If dcupl is not recognized after installation:

Check global bin path is in PATH:

npm config get prefix
# Ensure this path/bin is in your PATH

Try npx instead:
```
npx @dcupl/cli --version
```

Permission errors (macOS/Linux)

If you see EACCES permission errors:

# Option 1: Use a Node version manager (recommended)
# nvm, fnm, or volta handle permissions automatically

# Option 2: Fix npm permissions
mkdir ~/.npm-global
npm config set prefix '~/.npm-global'
echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.bashrc
source ~/.bashrc