---
title: Install
description: CLI installation, install source options, runtime requirements, and local checkout commands.
relatedCommands:
  - alpaca --help
  - alpaca auth setup --help
  - alpaca init --help
relatedDocs:
  - quick-start
  - setup
  - capabilities
  - config
---

# Install

Use this guide when installing the AlpacaLoop CLI or preparing a local checkout.

## Default Install

On macOS or Linux:

```bash
curl -fsSL https://raw.githubusercontent.com/alpacaloop/alpacaloop/main/install.sh | bash
```

The installer checks Node.js, installs the CLI, and prints the next setup step. Default Git installs require `git`, `npm`, and Node.js `>=22.19.0`.

To let the installer add missing Node.js tooling through `fnm`:

```bash
curl -fsSL https://raw.githubusercontent.com/alpacaloop/alpacaloop/main/install.sh | bash -s -- --install-deps
```

On Linux and WSL2, use a user-writable npm prefix such as fnm/nvm-managed Node.js. Distro Node.js packages can install `node` without `npm`; install `npm` manually or use `--install-deps` so the installer can use fnm-managed Node.js. If global `npm install -g` fails with EACCES, fix the npm prefix rather than running AlpacaLoop setup with sudo.

## Install Options

- `--install-deps` or `--yes`: install missing Node.js tooling through `fnm`.
- `--init`: run `alpaca init` after installing the CLI.
- `--source npm|git|tarball`: choose the package source.
- `--version <version>`: install a release tag, package version, or Git ref.
- `--no-modify-path`: prevent `fnm` from editing shell profile files.

If the registry package is unavailable in the current environment, use the Git URL:

```bash
npm install -g 'git+https://github.com/alpacaloop/alpacaloop.git#main'
```

When the registry package is available, use:

```bash
npm install -g alpacaloop
```

## Development Checkout

Use this only when working on AlpacaLoop itself:

```bash
git clone https://github.com/alpacaloop/alpacaloop.git
cd alpacaloop
pnpm install
pnpm build
```

From a checkout, run the CLI with `pnpm alpaca ...`.

## Command Names

The primary installed command is `alpaca`. The package also exposes `alpacaloop`. Tracker comments use `/alpaca`.

Use:

```bash
alpaca --help
alpaca help --all
man alpacaloop
alpaca docs list --with-description
alpaca docs search <query>
alpaca docs search <query> --view headings
```

## Related Docs

- `alpaca docs show quick-start`
- `alpaca docs show setup`
- `alpaca docs show capabilities`
- `alpaca docs show config`
