CLI Installation

Overview

The QODRYX CLI allows you to interact with the platform directly from your terminal. Trigger workflows, run security scans, deploy applications, and manage your projects without leaving your development environment.

Requirements

• Node.js: Version 18.0 or higher
• npm: Version 8.0 or higher (or yarn/pnpm)
• Operating System: macOS, Linux, or Windows 10+

Installation Methods

npm (Recommended)

Install globally using npm:

npm install -g @qodryx/cli

yarn

yarn global add @qodryx/cli

pnpm

pnpm add -g @qodryx/cli

Homebrew (macOS/Linux)

brew tap qodryx/tap
brew install qodryx

Shell Script (macOS/Linux)

curl -fsSL https://get.qodryx.com | sh

Windows (PowerShell)

iwr https://get.qodryx.com/windows | iex

Manual Download

Download the binary directly from our GitHub Releases page.

Verify Installation

After installation, verify the CLI is working:

qodryx --version
# Output: qodryx/1.0.0 darwin-arm64 node-v20.0.0

qodryx --help
# Shows available commands

Authentication

Log in to connect the CLI to your QODRYX account:

Interactive Login

qodryx auth login

# This will:
# 1. Open your browser to the login page
# 2. Ask you to authorize the CLI
# 3. Save credentials locally

Token-Based Login

For CI/CD environments or headless systems:

# Using a Personal Access Token
qodryx auth login --token YOUR_PAT_TOKEN

# Or set as environment variable
export QODRYX_API_KEY=qx_live_your_api_key
qodryx auth status

Verify Authentication

qodryx auth status

# Output:
# ✓ Authenticated as john@example.com
# ✓ Organization: Acme Corp
# ✓ Plan: Pro
# ✓ Token expires: 2024-12-31

Configuration

The CLI stores configuration in ~/.qodryx/:

~/.qodryx/
├── config.json     # CLI settings
├── credentials     # Authentication tokens
└── cache/          # Cached data

Global Configuration

# Set default project
qodryx config set default_project proj_abc123

# Set output format
qodryx config set output json  # json, table, or yaml

# View all config
qodryx config list

Project Configuration

Create a qodryx.yml in your project root for project-specific settings:

# qodryx.yml
project: proj_abc123

security:
  enabled: true
  scan_on_push: true

deployment:
  provider: vercel
  auto_deploy: false

notifications:
  slack: "#deployments"

Updating the CLI

npm

npm update -g @qodryx/cli

Self-Update

qodryx update

# Check for updates without installing
qodryx update --check

Homebrew

brew upgrade qodryx

Uninstalling

npm

npm uninstall -g @qodryx/cli

Homebrew

brew uninstall qodryx

Clean Up Config

rm -rf ~/.qodryx

Troubleshooting Installation

Permission Errors (npm)

# Option 1: Change npm's default directory
mkdir ~/.npm-global
npm config set prefix '~/.npm-global'
export PATH=~/.npm-global/bin:$PATH

# Add to ~/.bashrc or ~/.zshrc:
echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.bashrc

# Option 2: Use a Node version manager (nvm)
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash
nvm install 20
nvm use 20

Command Not Found

If qodryx command is not found after installation:

# Check npm global bin path
npm config get prefix

# Ensure it's in your PATH
echo $PATH

# Add to PATH if missing (add to ~/.bashrc or ~/.zshrc)
export PATH="$(npm config get prefix)/bin:$PATH"

Node Version Too Old

# Check Node version
node --version

# Install latest LTS with nvm
nvm install --lts
nvm use --lts

Platform-Specific Notes

Shell Completions

Enable tab completions for faster command entry:

Bash

# Add to ~/.bashrc
eval "$(qodryx completion bash)"

Zsh

# Add to ~/.zshrc
eval "$(qodryx completion zsh)"

Fish

qodryx completion fish > ~/.config/fish/completions/qodryx.fish

PowerShell

# Add to $PROFILE
qodryx completion powershell | Out-String | Invoke-Expression

Next Steps