Skip to main content
Getting started

Installation and Upgrade

Requirements

Before installing Qoder CLI CN, make sure your environment meets the following requirements:
  • Operating system: macOS, Linux, Windows (Windows Terminal recommended).
  • CPU architecture: arm64, amd64.
  • Node.js: Node.js >= 20.0.0 is required when installing via npm.
Windows (arm64) is not supported yet.

Install

Qoder CLI CN offers several installation methods. Pick whichever fits your environment and habits. The install script automatically downloads the build matching your system and sets up the executable. macOS / Linux 
curl -fsSL https://static.qoder.com.cn/qoder-cli-cn/install.sh | bash
Windows PowerShell 
irm https://static.qoder.com.cn/qoder-cli-cn/install.ps1 | iex
Windows CMD 
curl -fsSL https://static.qoder.com.cn/qoder-cli-cn/install.cmd -o install.cmd && install.cmd

Using npm

If you already have Node.js (>= 20.0.0) installed, you can install globally via npm: 
npm install -g @qodercn-ai/qoderclicn

Verify the installation

After installation, run the following command. If it prints the CLI version number, the installation succeeded: 
qodercn --version
If the command is not found, check whether the installation directory has been added to your system PATH. For troubleshooting steps, see Installation and Upgrade Issues.

First run

Run the following command in any project root to enter the default interactive (TUI) mode: 
qodercn
On first run, Qoder CLI CN guides you through sign-in. For sign-in methods, see Sign-in and Authentication.

Upgrade

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

Upgrade with the install script

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

Using the built-in update command

qodercn update

Upgrade via npm

npm install -g @qodercn-ai/qoderclicn@latest

Auto-update settings

Auto-update is enabled by default. To disable it, set general.enableAutoUpdate to false in ~/.qoder-cn/settings.json: 
{
  "general": {
    "enableAutoUpdate": false
  }
}
For configuration file scopes and precedence, see Settings Files and Precedence.

Uninstall

How to uninstall depends on how you installed:
  • Installed via npm: run npm uninstall -g @qodercn-ai/qoderclicn.
  • Installed via the install script: delete the executable placed by the install script, and remove the corresponding directory from PATH.
If you also want to clean up configuration and local data, delete the config directory (default ~/.qoder-cn). Before deleting, make sure it contains no sessions, memory, or settings you want to keep.
The config directory location can be customized with the QODERCN_CONFIG_DIR environment variable; the default is ~/.qoder-cn. If you have set this variable, delete the corresponding directory instead.
Getting started
Core concepts
Using Qoder CLI
Extending Qoder CLI
Integrations and remote
Configuration and security
Reference
Troubleshooting