> 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/readme.md).

# Celigo CLI

The Celigo CLI (`@celigo/celigo-cli`) is a first-party command-line tool for driving integrator.io. Anything you can do with the REST API you can do with `celigo <cmd>`, with profiles, safer writes, and account-wide utilities.

To compare the CLI with the REST API and Platform MCP, see [Which tool to use](https://developer.celigo.com/#which-tool-to-use).

* **Package:** [@celigo/celigo-cli on npm](https://www.npmjs.com/package/@celigo/celigo-cli)
* **Binary:** `celigo`
* **Requires:** Node.js 22.12 or newer
* **License:** MIT

## Quickstart

To get started quickly, [install the CLI](/cli/getting-started/install.md) and [authenticate](/cli/getting-started/authenticate.md): sign in through the browser with `celigo login`, or use a Celigo API token.

```bash
# 1. Install
npm install -g @celigo/celigo-cli

# 2. Point at an account: sign in through the browser (OAuth)…
celigo login    # creates a profile named after the account, e.g. acme-corp-production
# (an EU account: celigo login --base-url https://api.eu.integrator.io)

# …or use an API token
export CELIGO_API_TOKEN="<paste>"

# or, for multiple accounts:
celigo profile add prod --api-token "$PROD_TOKEN" --api-base-url https://api.integrator.io
celigo profile add eu   --api-token "$EU_TOKEN"   --api-base-url https://api.eu.integrator.io
celigo profile add au   --api-token "$AU_TOKEN"   --api-base-url https://api.au.integrator.io
celigo profile add ca   --api-token "$CA_TOKEN"   --api-base-url https://api.ca.integrator.io
celigo profile use prod

# 3. Do something
celigo integrations list --format table
celigo flows list --jq '.[] | {_id, name, disabled}'
```

On npm 11, a global install warns that the CLI has an install script: it downloads the jq binary `--jq` runs. See [Install](/cli/getting-started/install.md#npm-install-scripts-and-jq) for the `--allow-scripts` flag and the fallbacks.

The CLI also installs [AI assistant skills](/cli/using-the-cli/skills.md) for Claude Code, Cursor, and Windsurf in the background when you run it — so your AI assistant can give grounded answers about integrator.io.

## The account as files

`celigo pull` downloads the account, or one integration, as a folder tree of JSON documents — one folder per resource, links for every reference, a script's source as `script.js` beside its document. Edit the files with any editor, review them in git, check them with `celigo status`, `celigo diff`, and `celigo lint`, and write them back with `celigo push`, which prints its plan first and refuses to overwrite a resource someone changed since your pull. `celigo promote --to <profile>` writes the same tree into another account or environment. See [The local tree](/cli/local-tree.md); the [Celigo VS Code extension](/cli/vscode-extension.md) opens a pulled flow as the Flow Builder canvas.

## Command reference

One page per resource. Every subcommand lists its arguments and flags; commands that call the REST API link to the corresponding OpenAPI spec.


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://developer.celigo.com/cli/readme.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.