eazyBI CLI

The eazyBI command line interface (CLI) lets you work with your eazyBI accounts, reports, dashboards, and source data directly from a terminal. It authenticates with your eazyBI site using secure OAuth 2.0 authorization and calls the eazyBI JSON API on your behalf.

Overview

With the eazyBI CLI, you can list and manage accounts, reports, report folders, and dashboards, export report results in CSV, Excel, JSON, PDF, or PNG formats, export and import report and dashboard definitions, manage source applications and source files, start data imports, and call any eazyBI API endpoint directly.

The CLI is useful for two main purposes:

Automation of administrative tasks. Script repetitive tasks — for example, export report results on a schedule, copy report definitions from one account to another, upload updated source files and start data imports, or manage users and accounts from CI/CD pipelines and cron jobs. All commands support JSON output, making them easy to integrate with other tools in shell scripts.
Using eazyBI from AI agents. The CLI ships with an embedded agent skill that teaches AI coding agents (Claude Code, Codex, Gemini CLI, OpenCode, Rovo Dev, and other compatible agents) how to use the eazybi command. After installing the skill, you can ask your AI agent to explore accounts, create or update reports, export results, or automate any other eazyBI task in plain language.

The CLI works with eazyBI Cloud (eazybi.com), Atlassian Cloud sites (*.atlassian.net), Private eazyBI, and the eazyBI app for Jira or Confluence Data Center.

Installation

macOS or Linux

Run the installation script:

curl -fsSL https://go.eazybi.com/install-cli | bash

The script downloads the right build for your operating system and CPU, verifies its checksum, and installs the eazybi binary into ~/.local/bin (or ~/bin). Set the EAZYBI_BIN_DIR environment variable to choose a different directory, or EAZYBI_VERSION to pin a specific version.

Windows

Run in PowerShell:

irm https://go.eazybi.com/install-cli-ps1 | iex

The script installs eazybi.exe into %LOCALAPPDATA%\eazybi\bin and adds it to your user PATH.

Homebrew (macOS or Linux)

If you use Homebrew, install the CLI from the eazyBI tap:

brew install eazybi/tap/eazybi-cli

Upgrading

To upgrade to the latest version, re-run the installation script for your platform — it always installs the latest released version. If you installed with Homebrew, run:

brew update && brew upgrade eazybi/tap/eazybi-cli

Check the installed version with eazybi --version.

Log in to eazyBI

Before running other commands, log in to your eazyBI site:

# eazybi.com
eazybi auth login

# Atlassian Jira Cloud site
eazybi auth login -s example.atlassian.net

# Private eazyBI
eazybi auth login --base-url https://private.example.com/eazybi

# Jira or Confluence Data Center app
eazybi auth login --base-url https://jira.example.com/plugins/servlet/eazybi

The CLI opens your browser, where you authorize it with your eazyBI user. The access token is stored securely in your operating system keychain (macOS Keychain, Linux libsecret, or Windows Credential Manager). Access tokens expire after 24 hours and are refreshed automatically, so you rarely need to log in again. You can view and revoke CLI tokens from your eazyBI user profile settings.

By default, the CLI requests read-only access. Pass the --scopes option to request additional permissions:

eazybi auth login --scopes read,write

If you work with several eazyBI sites or users, create a named profile for each with eazybi auth login -p NAME, switch between them with eazybi auth select, and run any command against a specific profile with the -p NAME option. Use eazybi auth whoami to see which user and site you are currently using.

Install the AI agent skill

The CLI includes an embedded agent skill that teaches AI agents how to use the eazybi command. Install it for your agent:

eazybi skill install                # Claude Code (default), ~/.claude
eazybi skill install --agent codex  # Codex, ~/.codex
eazybi skill install --agent gemini # Gemini CLI, ~/.gemini
eazybi skill install --agent all    # all supported agents at once
eazybi skill install --project      # .claude/skills/ of the current project

Supported --agent values are claude, codex, gemini, opencode, rovodev, and agents (the generic .agents/skills/ convention).

After installing the skill and logging in, ask your AI agent, for example, to "list my eazyBI accounts", "export the Created vs resolved issues report as CSV", or "copy this report to another account" — the agent will use the eazybi CLI to do it.

You can inspect the bundled skill content before installing it with eazybi skill list and eazybi skill show, and remove an installed skill with eazybi skill uninstall.

When upgrading the CLI to a newer version, re-run eazybi skill install --force to update the installed skill files as well.

Main commands

Command	Description
`eazybi auth`	Log in and out, manage profiles, and show the current user: `login`, `logout`, `list`, `select`, `whoami`, `token`.
`eazybi accounts`	List accounts and select the default account for other commands: `list`, `select`.
`eazybi reports`	Manage reports and export report results: `list`, `show`, `create`, `update`, `delete`, `export` (CSV, Excel, JSON, PDF, or PNG), `export-definition`, `import-definition`.
`eazybi folders`	Manage report folders: `list`, `show`, `create`, `update`, `delete`.
`eazybi dashboards`	Manage dashboards and export them as PDF or PNG: `list`, `export`, `create`, `update`, `delete`, `export-definition`, `import-definition`.
`eazybi source-applications`	Manage source applications and data imports: `list`, `show`, `start-import`, `cancel-import`, `export-definition`, `import-definition`, and more.
`eazybi source-cubes`	Manage imported cubes: `list`, `show`, `empty`, `delete`.
`eazybi source-files`	Manage source files: `list`, `show`, `upload`, `replace`, `download`, `start-import`, `update-columns`, and more.
`eazybi skill`	Install, inspect, and uninstall the AI agent skill: `install`, `list`, `show`, `uninstall`.

Most commands operate on an account. Select a default account with eazybi accounts select, or pass the -a ACCOUNT_ID option to a specific command.

Some usage examples:

eazybi accounts list                       # list your accounts
eazybi reports list -a 1234                # list reports in account 1234
eazybi reports export 5678 --format csv    # export report results as CSV
eazybi reports list --json --jq '.[].name' # JSON output filtered with jq

By default, commands print human-readable tables. Add the --json option for JSON output (optionally slicing fields with --json=id,name), and the --jq option to apply a jq query to the JSON response — convenient for scripting.

Getting help

Every command and subcommand has built-in help with a description, available options, and examples:

eazybi --help                 # all commands and global options
eazybi reports --help         # subcommands of a command group
eazybi reports export --help  # detailed options of a specific subcommand