3. Prerequisites and Set-up

Before you start, install the tools below and gather credentials for whichever systems you're integrating. The 9 steps that follow take you from a blank machine through your first successful sync, in order, install the binary, create your Hivel API token, add your source-system credentials and config, validate the connection, and schedule recurring runs.

Requirement	Notes
curl	Pre-installed on most Linux/macOS systems
jq	brew install jq / apt install jq
Hivel API token	From Hivel dashboard → Settings → API Tokens - always required
Jira credentials	API token (Cloud) or PAT (Server/DC) - if integrating Jira
GitHub token	Personal Access Token - classic or fine-grained - if integrating GitHub
GitLab token	Personal Access Token with read_api scope - if integrating GitLab
Bitbucket token	Repository access token - if integrating Bitbucket
Azure DevOps token	Personal Access Token - if integrating Azure DevOps

Steps

1. Step 1 - Install the binary

2. Step 2 - Create your Hivel API token

3. Step 3 - Create credentials file

4. Step 4 - Create config.yml

5. Step 5 - Validate connectivity

6. Step 6 - Discover Jira custom fields (Jira only)

7. Step 7 - Add Jira custom fields to config

8. Step 8 - Run first sync

9. Step 9 - Scheduling

Getting Started

Commands & Workflow