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

# Hybrid (Hivel agent)

This section covers deploying Hivel's lightweight agent alongside your existing on-premises tools - from setup through configuration, troubleshooting, and verification. Use the table below to jump directly to any page.

<table data-search="false"><thead><tr><th>Page</th><th>Description</th></tr></thead><tbody><tr><td><a href="/hybrid-hivel-agent/hybrid-hivel-agent-quick-guide-tl-dr.md"><strong>TL;DR (Hybrid Agent)</strong></a></td><td>A condensed, copy-paste version of the full setup guide, same steps, compact explanations.</td></tr><tr><td><a href="/hybrid-hivel-agent/1.-overview.md"><strong>Overview</strong></a></td><td>Run Hivel's integration on your own infra.</td></tr><tr><td><a href="/hybrid-hivel-agent/2.-getting-started.md"><strong>Getting Started</strong></a></td><td>How the agent syncs metadata to Hivel.</td></tr><tr><td>↳ <a href="/hybrid-hivel-agent/2.-getting-started/network-calls-inbound-and-outbound.md">Network Calls (Inbound and Outbound)</a></td><td>Firewall/network requirements for the agent.</td></tr><tr><td>↳ <a href="/hybrid-hivel-agent/2.-getting-started/system-requirements.md">System Requirements</a></td><td>Minimum hardware/infra needed to run it.</td></tr><tr><td><a href="/hybrid-hivel-agent/3.-prerequisites-and-set-up.md"><strong>Prerequisites and Set-up</strong></a></td><td>9-step setup sequence overview.</td></tr><tr><td>↳ <a href="/hybrid-hivel-agent/3.-prerequisites-and-set-up/step-1-install-the-binary.md">Step 1 - Install the Binary</a></td><td>Download and install the agent binary.</td></tr><tr><td>↳ <a href="/hybrid-hivel-agent/3.-prerequisites-and-set-up/step-2-create-your-hivel-api-token.md">Step 2 - Create Your Hivel API Token</a></td><td>Generate an API token for auth.</td></tr><tr><td>↳ <a href="/hybrid-hivel-agent/3.-prerequisites-and-set-up/step-3-create-credentials-file.md">Step 3 - Create Credentials File</a></td><td>Add tokens for Hivel and source tools.</td></tr><tr><td>↳ <a href="/hybrid-hivel-agent/3.-prerequisites-and-set-up/step-4-create-config.yml.md">Step 4 - Create config.yml</a></td><td>Configure connections to Jira/GitHub/etc.</td></tr><tr><td>↳ <a href="/hybrid-hivel-agent/3.-prerequisites-and-set-up/step-5-validate-connectivity.md">Step 5 - Validate Connectivity</a></td><td>Verify connections before syncing.</td></tr><tr><td>↳ <a href="/hybrid-hivel-agent/3.-prerequisites-and-set-up/step-6-discover-jira-custom-fields-jira-only.md">Step 6 - Discover Jira Custom Fields (Jira only)</a></td><td>Map Jira field IDs via CLI tool.</td></tr><tr><td>↳ <a href="/hybrid-hivel-agent/3.-prerequisites-and-set-up/step-7-add-jira-custom-fields-to-config.md">Step 7 - Add Jira Custom Fields to Config</a></td><td>Add mapped Jira fields to config.</td></tr><tr><td>↳ <a href="/hybrid-hivel-agent/3.-prerequisites-and-set-up/step-8-run-first-sync.md">Step 8 - Run First Sync</a></td><td>Run the initial sync command.</td></tr><tr><td>↳ <a href="/hybrid-hivel-agent/3.-prerequisites-and-set-up/step-9-scheduling.md">Step 9 - Scheduling</a></td><td>Automate syncs via cron/systemd.</td></tr><tr><td><a href="/hybrid-hivel-agent/4.-commands-and-workflow.md"><strong>Commands &#x26; Workflow</strong></a></td><td>Index of CLI commands and workflows.</td></tr><tr><td>↳ <a href="/hybrid-hivel-agent/4.-commands-and-workflow/commands-reference.md">Commands Reference</a></td><td>List of CLI commands and flags.</td></tr><tr><td>↳ <a href="/hybrid-hivel-agent/4.-commands-and-workflow/credentials-required-per-command.md">Credentials Required per Command</a></td><td>Which tokens each command needs.</td></tr><tr><td>↳ <a href="/hybrid-hivel-agent/4.-commands-and-workflow/download-review-send-workflow.md">Download → Review → Send Workflow</a></td><td>Split data collection from upload for review.</td></tr><tr><td>↳ <a href="/hybrid-hivel-agent/4.-commands-and-workflow/files-generated-per-run.md">Files Generated per Run</a></td><td>Output files and logs per run.</td></tr><tr><td><a href="/hybrid-hivel-agent/5.-configuration-reference.md"><strong>Configuration Reference</strong></a></td><td>Index of config settings per platform.</td></tr><tr><td>↳ <a href="/hybrid-hivel-agent/5.-configuration-reference/hivel-managed-credentials.md">Hivel-Managed Credentials</a></td><td>Self-hosted vs. Hivel-managed credentials.</td></tr><tr><td>↳ <a href="/hybrid-hivel-agent/5.-configuration-reference/hivel-settings-hivel.md">Hivel Settings</a></td><td>API token and logging config.</td></tr><tr><td>↳ <a href="/hybrid-hivel-agent/5.-configuration-reference/jira-settings-jira.md">Jira Settings</a></td><td>Auth, sync, and filter options for Jira.</td></tr><tr><td>↳ <a href="/hybrid-hivel-agent/5.-configuration-reference/github-settings-github.md">GitHub Settings</a></td><td>Config for GitHub Cloud/Enterprise.</td></tr><tr><td>↳ <a href="/hybrid-hivel-agent/5.-configuration-reference/gitlab-settings-gitlab.md">GitLab Settings</a></td><td>Multi-instance GitLab config.</td></tr><tr><td>↳ <a href="/hybrid-hivel-agent/5.-configuration-reference/bitbucket-settings-bitbucket.md">Bitbucket Settings</a></td><td>Config for Bitbucket integration.</td></tr><tr><td>↳ <a href="/hybrid-hivel-agent/5.-configuration-reference/azure-devops-settings-azure.md">Azure DevOps Settings</a></td><td>Config for Azure DevOps integration.</td></tr><tr><td>↳ <a href="/hybrid-hivel-agent/5.-configuration-reference/claudeotel-settings-claudeotel.md">claudeotel-settings</a></td><td>Config for claude open telemetry integration.</td></tr><tr><td>↳ <a href="/hybrid-hivel-agent/5.-configuration-reference/full-config-example.md">Full Config Example</a></td><td>Sample full config.yml file.</td></tr><tr><td><a href="/hybrid-hivel-agent/7.-troubleshooting-and-security-notes.md"><strong>Troubleshooting &#x26; Security Notes</strong></a></td><td>Common fixes and security practices.</td></tr><tr><td><a href="/hybrid-hivel-agent/8.-work-metrics-credentials-and-controls.md"><strong>Work-metrics, Credentials &#x26; Controls</strong></a></td><td>Repo cloning, credentials, and privacy controls.</td></tr><tr><td><a href="/hybrid-hivel-agent/9.-verification-and-summary.md"><strong>Verification &#x26; Summary</strong></a></td><td>Inspect data before upload; what's sent vs. protected.</td></tr></tbody></table>

{% columns %}
{% column %}

{% endcolumn %}

{% column %}

{% endcolumn %}

{% column %} <a href="/hybrid-hivel-agent/hybrid-hivel-agent-quick-guide-tl-dr.md" class="button primary" data-icon="forward">TL;DR (Hybrid Agent)</a>
{% endcolumn %}
{% endcolumns %}