Skip to main content

Installation Guide

This guide will help you install ConnectDev CLI on your system. Choose the installation method that best suits your needs.

Quick Install​

Using pip (Python Package Manager)​

pip install connectdev

Using Homebrew (macOS)​

# Install
brew install ishowmaker/tap/connectdev

# Upgrade to latest version
brew upgrade connectdev

Using Installation Scripts​

Linux and macOS​

curl -fsSL https://raw.githubusercontent.com/ishowmaker/showmaker-cli/master/install.sh | bash

Windows PowerShell​

Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://raw.githubusercontent.com/ishowmaker/showmaker-cli/main/install.ps1'))

Homebrew​

# Add our tap
brew tap ishowmaker/tap

# Install
brew install connectdev

# Upgrade
brew upgrade connectdev

# Uninstall
brew uninstall connectdev

Windows​

  1. Download connectdev-windows.exe.zip from the releases page
  2. Extract the ZIP file
  3. Move connectdev.exe to a directory in your PATH
  4. (Optional) Add the directory to your system's PATH if needed

Detailed Installation Guide​

Prerequisites​

  • For pip installation: Python 3.7 or higher
  • For Homebrew: macOS 10.15 or higher
  • For Windows: Windows 10 or higher
  • Administrative privileges for system-wide installation

Installation Methods​

The pip installation method is recommended if you're already using Python:

# Install
pip install connectdev

# Upgrade
pip install --upgrade connectdev

# Uninstall
pip uninstall connectdev

Homebrew provides an easy way to install ConnectDev CLI on macOS:

# Add our tap
brew tap ishowmaker/tap

# Install
brew install connectdev

# Upgrade
brew upgrade connectdev

# Uninstall
brew uninstall connectdev

3. Manual Installation​

You can manually download and install the binary for your system from our releases page.

Linux (x86_64)​
# Download the latest release
curl -LO https://github.com/ishowmaker/showmaker-cli/releases/download/latest/connectdev-linux-x86_64.tar.gz

# Extract the archive
tar xzf connectdev-linux-x86_64.tar.gz

# Move to your bin directory
sudo mv connectdev /usr/local/bin/

# Make it executable
sudo chmod +x /usr/local/bin/connectdev
macOS (Universal)​
# Download the latest release
curl -LO https://github.com/ishowmaker/showmaker-cli/releases/download/latest/connectdev-macos-arm64.tar.gz

# Extract the archive
tar xzf connectdev-macos-arm64.tar.gz

# Move to your bin directory
sudo mv connectdev /usr/local/bin/

# Make it executable
sudo chmod +x /usr/local/bin/connectdev
Windows​
  1. Download connectdev-windows.exe.zip from the releases page
  2. Extract the ZIP file
  3. Move connectdev.exe to a directory in your PATH
  4. (Optional) Add the directory to your system's PATH if needed

Verifying the Installation​

After installation, verify that ConnectDev CLI is installed correctly:


# View help
connectdev --help

Updating ConnectDev CLI​

Choose the update method based on your installation:

  • pip: pip install --upgrade connectdev
  • Homebrew: brew upgrade connectdev
  • Manual: Download and install the new version
  • Scripts: Run the installation script again

Troubleshooting​

Common Issues​

  1. Permission Denied

    # Linux/macOS
    sudo chmod +x /usr/local/bin/connectdev

  2. Command Not Found

    • Ensure the installation directory is in your PATH
    • Try restarting your terminal

  3. Installation Fails

    • Check your internet connection
    • Verify system requirements
    • Ensure you have necessary permissions

System Requirements​

  • Operating Systems:
    • Linux: x86_64
    • macOS: 10.15 or later (Universal Binary)
    • Windows: Windows 10 or later (64-bit)
  • Python: 3.7 or higher (for pip installation)

Support and Help​