> For the complete documentation index, see [llms.txt](https://developer.celigo.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.celigo.com/cli/getting-started/install.md).

# Install

## Requirements

* **Node.js 22 or newer.** Check with `node --version`.
* **npm** (bundled with Node) or an equivalent registry client (pnpm, yarn).

## Global install (recommended)

```bash
npm install -g @celigo/celigo-cli
celigo --version
```

This puts the `celigo` binary on your `PATH`. On macOS/Linux the npm global prefix is typically `/usr/local/bin`; on Windows it's under `%AppData%\npm\celigo.cmd`.

## One-off invocation without install

```bash
npx --yes @celigo/celigo-cli --version
```

Useful in CI when you want to pin a specific version in a workflow file.

## Upgrading

```bash
npm install -g @celigo/celigo-cli@latest
```

The CLI checks npm for a newer version every four hours on startup and auto-installs it unless suppressed. Skip the check with `CELIGO_NO_UPDATE=1`. CI environments are detected (`CI`, `GITHUB_ACTIONS`, `GITLAB_CI`, `JENKINS_URL`, `CIRCLECI`, `BUILDKITE`, …) and the check is skipped automatically.

## Uninstalling

> ⚠️ **`rm -rf ~/.celigo` is irreversible.** It permanently deletes your saved profiles, tokens, config, and the account index. Omit it if you plan to reinstall the CLI later.

```bash
npm uninstall -g @celigo/celigo-cli
rm -rf ~/.celigo     # removes profiles, config, and the account index
```

## Verifying the install

```bash
$ celigo --version
2026.6.1

$ celigo --help
Usage: celigo [options] [command]

Options:
  -v, --version        output the version number
  --token <token>      API bearer token (prefer CELIGO_API_TOKEN env var to
                       avoid exposing in process list).
  --base-url <url>     API base URL.
  --format <format>    Output format (json or table). Defaults to config or
                       json.
  --jq <expr>          Transform JSON output with a jq expression.
  --verbose            Show HTTP requests.
  --profile <name>     Use a named config profile instead of the active profile.
  -h, --help           display help for command

Commands:
  config     Manage CLI configuration.
  profile    Manage named config profiles
  account    Account-wide operations: snapshot, search, dependencies, lint, stats
  flows      Manage flows
  connections, exports, imports, integrations, scripts, …
```

If `celigo` isn't found after install, make sure the npm global `bin` directory is on your `PATH`:

```bash
npm bin -g    # prints the directory
```

Add that path to your shell rc file (`~/.zshrc`, `~/.bashrc`, or PowerShell `$PROFILE`).

## Releases & versioning

The CLI uses calendar versioning (e.g. `2026.6.1` = 2026-06, patch 1). Release notes and tarballs live on the [npm package page](https://www.npmjs.com/package/@celigo/celigo-cli).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://developer.celigo.com/cli/getting-started/install.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.