Skip to main content

CLI Installation

Complete guide to installing and setting up the QuikDB Nodes CLI tool.

Quick Installation​

The fastest way to get started with QuikDB Nodes:

# Install globally via npm
npm install -g quikdb-nodes

# Verify installation
quikdb-nodes --version

Alternative Installation Methods​

Using Yarn​

yarn global add quikdb-nodes

Using pnpm​

pnpm add -g quikdb-nodes

Using Homebrew (macOS)​

# Add the QuikDB tap (coming soon)
brew tap quikdb/tap
brew install quikdb-nodes

Using Chocolatey (Windows)​

# Coming soon
choco install quikdb-nodes

Using Package Managers (Linux)​

# Ubuntu/Debian (coming soon)
curl -fsSL https://cli.quikdb.com/install.sh | bash

# Arch Linux (coming soon)
yay -S quikdb-nodes

Manual Installation​

If you prefer to install manually or automated installation doesn't work:

  1. Download the latest release from GitHub
  2. Extract the archive to your preferred directory
  3. Add the binary to your system PATH
  4. Verify the installation with quikdb-nodes --version

Post-Installation​

After installation, verify everything is working:

# Check version
quikdb-nodes --version

# View available commands
quikdb-nodes --help

# Test CLI connectivity
quikdb-nodes info

Troubleshooting​

Permission Issues​

If you encounter permission errors:

# macOS/Linux: Use sudo (not recommended for npm)
sudo npm install -g quikdb-nodes

# Better: Configure npm to use a different directory
npm config set prefix ~/.local
echo 'export PATH=~/.local/bin:$PATH' >> ~/.bashrc
source ~/.bashrc
npm install -g quikdb-nodes

Command Not Found​

If quikdb-nodes is not recognized:

  1. Check if the global npm bin directory is in your PATH:

    npm bin -g
    echo $PATH

  2. Add npm global bin to your PATH:

    # Add to ~/.bashrc, ~/.zshrc, or equivalent
    export PATH=$(npm bin -g):$PATH

  3. Restart your terminal

Version Conflicts​

If you have multiple versions installed:

# Uninstall all versions
npm uninstall -g quikdb-nodes

# Clear npm cache
npm cache clean --force

# Reinstall latest version
npm install -g quikdb-nodes

Updating​

Keep your CLI updated to access the latest features:

# Check current version
quikdb-nodes --version

# Update to latest version
npm update -g quikdb-nodes

# Or reinstall
npm uninstall -g quikdb-nodes
npm install -g quikdb-nodes

Uninstalling​

To completely remove the CLI:

# Uninstall via npm
npm uninstall -g quikdb-nodes

# Remove configuration files (optional)
rm -rf ~/.quikdb-nodes/

Next Steps​

After installation, you'll want to:

  1. Authenticate with QuikDB
  2. Set up your development environment
  3. Deploy your first application

Need help? Check our Support Guide or join our Community.