DocsGet started
Install
One line on macOS, Linux and WSL. Or npm, anywhere Node.js runs.
How do I install Alran Code?
curl -fsSL https://alran.dev/install.sh | bashThe script needs nothing but curl (or wget) and tar. It:
- Checks your system: macOS or Linux on x64 or arm64. WSL counts as Linux.
- Uses your Node.js if it is a supported version (22.19 or newer on 22, 24.2 or newer on 24, 25 or 26). If not, it downloads Node.js 24 from nodejs.org, checks its SHA-256 and keeps it inside the install folder. Your system Node.js stays untouched.
- Installs the
alranpackage into~/.alran-codeand puts the launcher at~/.alran-code/bin/alran. - Adds that folder to your
PATHin your shell's startup file, marked with# Alran Code CLI.
Open a new terminal afterwards, then run alran --version.
| Variable | What it does | Default |
|---|---|---|
ALRAN_INSTALL_DIR | Where Alran Code is installed | ~/.alran-code |
ALRAN_VERSION | The version to install | latest |
ALRAN_NO_MODIFY_PATH | 1 leaves your shell files alone | not set |
curl -fsSL https://alran.dev/install.sh | ALRAN_VERSION=0.6.9 bashWant to read it first? Download, read, then run: curl -fsSL https://alran.dev/install.sh -o install.sh, then less install.sh and bash install.sh.
With npm
Node.js 22.19 or newer (22.x), 24.2 or newer (24.x), 25 or 26. Node 24.0 and 24.1 are not supported.
npm install -g alran
alran --versionpnpm, yarn and bun work the same way: pnpm add -g alran, yarn global add alran, bun add -g alran. Keep optional dependencies enabled and allow the native SQLite install script of better-sqlite3 (npm does by default). Without a prebuilt binary for your Node version, native dependencies need Python and C/C++ build tools.
Windows
Run the installer inside WSL, or install with npm in PowerShell: npm install -g alran.
Update
| Installed with | Update |
|---|---|
| npm, pnpm, yarn or bun | alran update |
| The installer | Run the install command again. It replaces the version in place. |
Alran Code checks for updates once a week and shows a hint. ALRAN_NO_UPDATE_CHECK=1 turns the hint off.
Uninstall
Close running sessions first, including editor integrations.
# installed with the script
rm -rf -- "$HOME/.alran-code"
# then delete the "# Alran Code CLI" line and the
# PATH line after it from your shell startup file
# installed with npm
npm uninstall -g alranYour sign-in, settings and sessions live separately in ~/.alran and stay in place. Delete that folder only if you want them gone too.
Build from source
You need Git, Node.js (as above) and pnpm 9.12.0.
git clone https://github.com/Alran-AI/code.git
cd code
corepack enable
pnpm install --frozen-lockfile
pnpm build
pnpm alran --helpTo use a source build in another project, run the built entry point by its absolute path: node /absolute/path/to/code/dist/cli.js.
Common questions
How do I install Alran Code on macOS?
Run curl -fsSL https://alran.dev/install.sh | bash in your terminal. The script checks that you are on macOS or Linux on x64 or arm64, installs the alran package into ~/.alran-code, puts the launcher at ~/.alran-code/bin/alran and adds that folder to the PATH in the startup file of your shell. If you prefer npm, npm install -g alran works everywhere Node.js runs.
Which Node.js versions does Alran Code support?
Node.js 22.19 or newer on 22.x, 24.2 or newer on 24.x, and 25 or 26. Node 24.0 and 24.1 are not supported. The installer uses your own Node.js when the version fits and otherwise downloads Node.js 24 into the install folder, without touching your system Node.js.
How do I uninstall Alran Code without losing my sessions?
Close your running sessions first, then delete the ~/.alran-code folder (or run npm uninstall -g alran) and remove the line marked # Alran Code CLI together with the PATH line after it from your shell startup file. Your sign-in, settings and sessions live separately in ~/.alran and stay in place, so delete that folder only if you want them gone too.