Skip to main content
Getting Started

Installation and Upgrade

Requirements

Before installing Qoder CLI, ensure your environment meets the following requirements:
  • Operating System: macOS, Linux, Windows (Windows Terminal is recommended).
  • CPU Architecture: arm64, amd64.
  • Node.js: Node.js >= 20.0.0 is required only for the legacy npm installation method.
Windows (arm64) is not currently supported.

Installation

Use the installation script for new installations. It installs the native standalone executable and typically provides better startup and runtime performance than the npm package, especially on Windows. The installation script automatically selects a compatible native build for your operating system and CPU architecture, downloads it, and configures the executable. macOS / Linux
curl -fsSL https://qoder.com/install | bash
Windows PowerShell
irm https://qoder.com/install.ps1 | iex
Windows CMD
curl -fsSL https://qoder.com/install.cmd -o install.cmd && install.cmd
The npm package runs the JavaScript bundle on Node.js instead of using the native standalone runtime, so startup and runtime performance may be lower, particularly on Windows. This method is retained for compatibility with existing environments; use the installation script for new installations. If you still need the npm compatibility path, install Node.js >= 20.0.0 and run:
npm install -g @qoder-ai/qodercli

Verifying the Installation

After installation, run the following command. If the CLI version number is printed, the installation was successful:
qoder --version
If you receive a "command not found" error, check whether the installation directory has been added to the system PATH. For troubleshooting steps, see Installation and Upgrade issues.

First Run

Run the following command in any project root directory to enter the default interactive (TUI) mode:
qoder
On the first run, Qoder CLI will guide you through the sign-in process. For details on sign-in methods, see Sign-in and Authentication.

Upgrade

Qoder CLI has Auto-Upgrade enabled by default. You can also manually upgrade to the latest version at any time.

Upgrading via the Installation Script

macOS / Linux
curl -fsSL https://qoder.com/install | bash -s -- --force
Windows PowerShell
irm https://qoder.com/install.ps1 | iex
Windows CMD
curl -fsSL https://qoder.com/install.cmd -o install.cmd && install.cmd

Using the Built-in Update Command

qoder update

Upgrading an Existing npm Installation

Existing npm installations can continue to upgrade with the following command while migrating to the recommended installation script:
npm install -g @qoder-ai/qodercli@latest

Auto-Upgrade Settings

Auto-Upgrade is enabled by default. To disable it, set general.enableAutoUpdate to false in ~/.qoder/settings.json:
{
  "general": {
    "enableAutoUpdate": false
  }
}
For the scope and application order of configuration files, see Configuration files and application order.

Uninstallation

The uninstallation method depends on how you installed it:
  • Installed via npm: Run npm uninstall -g @qoder-ai/qodercli.
  • Installed via the installation script: Delete the executable placed by the installation script and remove the corresponding directory from PATH.
If you also want to clean up configuration and local data, you can delete the configuration directory (default: ~/.qoder). Before deleting, ensure there are no sessions, memories, or settings you need to keep.
The configuration directory location can be customized via the QODER_CONFIG_DIR Environment Variable, with the default being ~/.qoder. If you have set this variable, delete the corresponding directory.