Getting Started

This guide walks you through installing and configuring Adaptavist for the first time. You will be up and running in under ten minutes.

Prerequisites

Before you begin, make sure your environment meets the following requirements:

Node.js 18 or later
A supported Jira Cloud or Jira Data Center instance
An Adaptavist licence key (trial licences are available)

Installation

Install the Adaptavist CLI globally using npm:

npm install --global @adaptavist/cli

Verify the installation succeeded by checking the version:

adaptavist --version

Configuration

Run the interactive setup wizard to connect the CLI to your Jira instance:

adaptavist init

The wizard will prompt you for your Jira base URL, credentials, and licence key. Values are stored in ~/.adaptavist/config.json and can be edited directly at any time.

Store secrets in environment variables rather than the config file when running in CI/CD environments. The CLI reads ADAPTAVIST_API_TOKEN automatically if set.

First Run

Once configured, validate the connection by listing available projects:

adaptavist projects list

A table of accessible Jira projects is printed. If you see an authentication error, double-check your API token and Jira base URL in the config file.

Next Steps

You are ready to explore more of the platform:

Read the API Reference to learn about all available commands and REST endpoints.
Check out the configuration guide for advanced settings and environment variables.

← Home API Reference →