> For the complete documentation index, see [llms.txt](https://docs.hivel.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.hivel.ai/hybrid-hivel-agent/3.-prerequisites-and-set-up.md).

# 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.

<table data-header-hidden data-search="false"><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><strong>Requirement</strong></td><td><strong>Notes</strong></td></tr><tr><td>curl</td><td>Pre-installed on most Linux/macOS systems</td></tr><tr><td>jq</td><td>brew install jq / apt install jq</td></tr><tr><td>Hivel API token</td><td>From Hivel dashboard → Settings → API Tokens - always required</td></tr><tr><td>Jira credentials</td><td>API token (Cloud) or PAT (Server/DC) - if integrating Jira</td></tr><tr><td>GitHub token</td><td>Personal Access Token - classic or fine-grained - if integrating GitHub</td></tr><tr><td>GitLab token</td><td>Personal Access Token with read_api scope - if integrating GitLab</td></tr><tr><td>Bitbucket token</td><td>Repository access token - if integrating Bitbucket</td></tr><tr><td>Azure DevOps token</td><td>Personal Access Token - if integrating Azure DevOps</td></tr></tbody></table>

### Steps

1. [Step 1 - Install the binary](/hybrid-hivel-agent/3.-prerequisites-and-set-up/step-1-install-the-binary.md)
2. [Step 2 - Create your Hivel API token](/hybrid-hivel-agent/3.-prerequisites-and-set-up/step-2-create-your-hivel-api-token.md)
3. [Step 3 - Create credentials file](/hybrid-hivel-agent/3.-prerequisites-and-set-up/step-3-create-credentials-file.md)
4. [Step 4 - Create config.yml](/hybrid-hivel-agent/3.-prerequisites-and-set-up/step-4-create-config.yml.md)
5. [Step 5 - Validate connectivity](/hybrid-hivel-agent/3.-prerequisites-and-set-up/step-5-validate-connectivity.md)
6. [Step 6 - Discover Jira custom fields (Jira only)](/hybrid-hivel-agent/3.-prerequisites-and-set-up/step-6-discover-jira-custom-fields-jira-only.md)
7. [Step 7 - Add Jira custom fields to config](/hybrid-hivel-agent/3.-prerequisites-and-set-up/step-7-add-jira-custom-fields-to-config.md)
8. [Step 8 - Run first sync](/hybrid-hivel-agent/3.-prerequisites-and-set-up/step-8-run-first-sync.md)
9. [Step 9 - Scheduling](/hybrid-hivel-agent/3.-prerequisites-and-set-up/step-9-scheduling.md)

{% columns %}
{% column %} <a href="/hybrid-hivel-agent/2.-getting-started.md" class="button primary" data-icon="backward">Getting Started</a>
{% endcolumn %}

{% column %}

{% endcolumn %}

{% column %} <a href="/hybrid-hivel-agent/4.-commands-and-workflow.md" class="button primary" data-icon="forward">Commands & Workflow</a>
{% endcolumn %}
{% endcolumns %}