-
Notifications
You must be signed in to change notification settings - Fork 0
Installation
This guide will help you install DoPlan CLI on your platform. DoPlan CLI is a zero-install tool, meaning you can use it without any installation via npx, or install it permanently on your system.
Before installing DoPlan CLI, ensure you have:
-
Node.js >= 14.0.0 (required for
npxwrapper) - Go >= 1.23.0 (only required if building from source)
Check Node.js version:
node --versionCheck Go version (if building from source):
go versionThe easiest way to use DoPlan CLI is via npx - no installation required!
npx @doplan-dev/cliThis will automatically:
- Download the correct binary for your platform
- Run DoPlan CLI immediately
- No files are installed on your system
Note: The first run may take a few seconds to download the binary. Subsequent runs are instant.
# Add tap (if needed)
brew tap doplan-dev/cli
# Install
brew install doplanVerify installation:
doplan --versionnpx @doplan-dev/cli- Visit GitHub Releases
- Download the appropriate binary:
-
doplan-darwin-amd64for Intel Macs -
doplan-darwin-arm64for Apple Silicon (M1/M2/M3)
-
- Make it executable and move to PATH:
# For Intel Macs
chmod +x doplan-darwin-amd64
mv doplan-darwin-amd64 /usr/local/bin/doplan
# For Apple Silicon
chmod +x doplan-darwin-arm64
mv doplan-darwin-arm64 /usr/local/bin/doplan# Clone the repository
git clone https://github.com/DoPlan-dev/CLI.git
cd CLI
# Build the binary
go build -o doplan ./cmd/doplan
# Install to system
sudo mv doplan /usr/local/bin/# Add bucket
scoop bucket add doplan https://github.com/DoPlan-dev/scoop-bucket.git
# Install
scoop install doplanVerify installation:
doplan --versionnpx @doplan-dev/cli- Visit GitHub Releases
- Download
doplan-windows-amd64.exe - Rename to
doplan.exe - Add to your PATH:
- Option A: Move to a directory already in PATH (e.g.,
C:\Windows\System32) - Option B: Add the directory containing
doplan.exeto your PATH environment variable
- Option A: Move to a directory already in PATH (e.g.,
Adding to PATH:
- Open System Properties → Environment Variables
- Edit the
Pathvariable under User variables - Add the directory containing
doplan.exe - Click OK and restart your terminal
# Clone the repository
git clone https://github.com/DoPlan-dev/CLI.git
cd CLI
# Build the binary
go build -o doplan.exe ./cmd/doplan
# Use from current directory or add to PATHnpx @doplan-dev/cli# Download latest release
curl -L https://github.com/DoPlan-dev/CLI/releases/latest/download/doplan-linux-amd64 -o doplan
# Make executable
chmod +x doplan
# Move to PATH
sudo mv doplan /usr/local/bin/For ARM64 Linux:
curl -L https://github.com/DoPlan-dev/CLI/releases/latest/download/doplan-linux-arm64 -o doplan
chmod +x doplan
sudo mv doplan /usr/local/bin/# Clone the repository
git clone https://github.com/DoPlan-dev/CLI.git
cd CLI
# Build the binary
go build -o doplan ./cmd/doplan
# Install to system
sudo mv doplan /usr/local/bin/Debian/Ubuntu:
When .deb packages are available:
# Download .deb package
wget https://github.com/DoPlan-dev/CLI/releases/latest/download/doplan_amd64.deb
# Install
sudo dpkg -i doplan_amd64.debArch Linux:
When AUR package is available:
# Using yay
yay -S doplan-cli
# Or using paru
paru -S doplan-cliDoPlan CLI is available as a Docker image for containerized environments.
docker run --rm -it -v $(pwd):/workspace doplan/clidocker run --rm -it \
-v $(pwd):/workspace \
-w /workspace \
doplan/clidocker run --rm -it \
-v $(pwd):/workspace \
doplan/cli:1.0.0Note: Replace $(pwd) with %cd% on Windows PowerShell.
After installation, verify that DoPlan CLI is working correctly:
doplan --versionYou should see output like:
doplan version 1.0.4
Try running DoPlan CLI to ensure everything works:
# Using npx (no installation)
npx @doplan-dev/cli
# Or if installed
doplanYou should see the interactive wizard start.
Solution:
-
Verify the binary is in your PATH:
# macOS/Linux which doplan # Windows where doplan
-
If not found, add the binary location to your PATH:
-
macOS/Linux: Add to
~/.bashrc,~/.zshrc, or~/.profile - Windows: Add to System Environment Variables
-
macOS/Linux: Add to
-
Restart your terminal after updating PATH
Solution:
chmod +x doplanOr if installed to system location:
sudo chmod +x /usr/local/bin/doplanSolution:
-
Clear npm cache:
npm cache clean --force
-
Try again:
npx @doplan-dev/cli
-
Check your internet connection (first run requires download)
Solution:
- macOS: Ensure you download the correct binary for your chip (Intel vs Apple Silicon)
-
Linux: Check if you need
amd64orarm64version - Windows: Ensure you're using 64-bit Windows
Solution:
-
Update Homebrew:
brew update
-
Check if tap exists:
brew tap doplan-dev/cli
-
Try installing again:
brew install doplan
Solution:
-
Ensure Go >= 1.23.0 is installed:
go version
-
Ensure you have internet access (for downloading dependencies)
-
Try building with verbose output:
go build -v -o doplan ./cmd/doplan
Solution:
-
Pull the image explicitly:
docker pull doplan/cli:latest
-
Check available tags:
docker search doplan/cli
No update needed! npx always uses the latest version.
brew upgrade doplanscoop update doplan- Download the latest release from GitHub Releases
- Replace the existing binary
- Verify:
doplan --version
docker pull doplan/cli:latestbrew uninstall doplanscoop uninstall doplanRemove the binary from your PATH:
# macOS/Linux
sudo rm /usr/local/bin/doplan
# Windows
# Delete doplan.exe from the directory in your PATHAfter successful installation:
- Quick Start Guide - Create your first project
- Commands Reference - Learn all available commands
- Workflow Guide - Understand the development workflow
- Quick Start - Get started with your first project
- Troubleshooting - Common issues and solutions
- FAQ - Frequently asked questions
- Home - Wiki home page
Last Updated: 2025
Maintained By: Documentation Team