> For the complete documentation index, see [llms.txt](https://docs.tunnelhub.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.tunnelhub.io/readme.md).

# TunnelHub

TunnelHub é uma plataforma de integração, automação e gerenciamento de APIs orientada a times que precisam operar fluxos em produção, com observabilidade, segurança e separação por ambiente.

Esta documentação ajuda você a configurar, usar e acompanhar suas integrações no TunnelHub. Comece pelos guias e consulte as referências de cada recurso conforme sua necessidade.

Hoje a plataforma combina quatro frentes principais:

* Produto web para configurar ambientes, pacotes, Tabelas De/Para, sistemas, automações, APIs, usuários e configurações administrativas.
* SDK em TypeScript para implementar automações com fluxos prontos, logging, delta, parâmetros, Tabelas De/Para e Sequências.
* CLI para autenticar, listar recursos, criar pacotes, criar automações e publicar novas versões.
* MCP para consultar recursos, investigar execuções e realizar operações pelo seu assistente de IA, respeitando as permissões da sua conta.

## O que você encontra no TunnelHub

* **Produto**: ambientes, pacotes, Tabelas De/Para, sistemas, automações, Tabelas de Apoio, Sequências, monitoramento e administração.
* **API Management**: definição de APIs, planos de uso, chaves de API, servidores de recursos, clientes e logs de execução.
* **Developer tooling**: CLI, SDK, MCP e skill para agentes com papéis diferentes no ciclo de desenvolvimento e suporte.

## Como navegar nesta documentação

* Se você está começando agora, siga [Criando sua primeira automação](/primeiros-passos/creating-your-first-automation.md).
* Se você quer entender o modelo do produto, comece por [Conceitos principais](/produto/core-concepts.md).
* Se você precisa modelar configuração operacional no produto, leia [Tabelas De/Para](/produto/data-stores.md) e [Sistemas](/produto/systems.md).
* Se você vai desenvolver integrações, consulte as seções de [CLI](/cli/cli.md) e [SDK](/sdk/sdk.md).
* Se você vai investigar execuções ou operar o ambiente via cliente MCP, consulte [MCP](/mcp/mcp.md).

## Skill para agentes

Se você desenvolve automações com frequência, vale instalar o skill público `tunnelhub-sdk`. Ele ajuda a trabalhar com os fluxos do SDK, parâmetros, sistemas, Tabelas De/Para, Sequências, logging, interceptor HTTP e testes em plataformas de agentes compatíveis.

Instalação:

```bash
npx skills add tunnelhub/agent-skills --skill tunnelhub-sdk -a opencode
```

Instalação global:

```bash
npx skills add tunnelhub/agent-skills --skill tunnelhub-sdk -a opencode -g
```

## Requisitos gerais

* Node.js 22 ou superior para usar a CLI ou desenvolver com o SDK.
* Acesso a uma conta TunnelHub com pelo menos um ambiente.
* Permissões adequadas para criar pacotes, automações, APIs ou usuários, dependendo do seu perfil.

## Principais conceitos

* **Ambiente**: separa configuração e execução, como DEV, QAS e PRD.
* **Pacote**: agrupador lógico de automações, sistemas e artefatos relacionados.
* **Sistema**: definição reutilizável de conexão com serviços externos.
* **Automação**: execução serverless ou em container que processa integrações e gera logs operacionais.
* **Tabela De/Para**: conjunto de dados configurável no produto, usado para mapeamentos, listas de referência e traduções de valores.
* **Tabela de Apoio**: tabela relacional gerenciada pelo produto para dados operacionais estruturados.
* **Sequência**: gerador sequencial para identificadores controlados pela plataforma.

Se precisar de ajuda para escolher um caminho, comece por [Conceitos principais](/produto/core-concepts.md).