Conecte um agente

Você precisa do Node.js 20 ou mais recente e de uma chave de um Perfil com acesso a pelo menos um documento indexado. Se você ainda não tiver isso, siga Sua primeira recuperação.

Execute a versão mais recente da CLI com npx, ou instale-a globalmente:

npx takibibase@latest --help
npm i -g takibibase   # then: takibi --help

Prefere um único arquivo? Baixe takibi.mjs e salve-o como tools/takibi/takibi.mjs no seu diretório de trabalho. A CLI é um único arquivo sem dependências de pacote. Execute-a com Node, ou crie um alias:

alias takibi='node /absolute/path/to/tools/takibi/takibi.mjs'
takibi --help

Baixe a habilidade do agente Takibi no diretório de habilidades da sua ferramenta, ou instale-a pela CLI com takibi skill --install (repita --dir <skills-root> por caixa personalizada; --force atualiza uma cópia mais antiga). Você também pode dar as instruções diretamente ao seu agente. A habilidade assume um comando takibi no PATH ou npx takibibase@latest. As ferramentas podem rodar em diretórios de trabalho diferentes, então verifique o caminho também do ambiente do agente.

A CLI verifica atualizações uma vez por dia e imprime um aviso de uma linha quando existe uma versão mais recente. O aviso vai para stderr, então scripts e saída --json não são afetados.

A CLI conversa com os servidores do Takibi por padrão. Não há endpoint para configurar. Salve a chave onde o agente roda:

mkdir -p ~/.takibi
touch ~/.takibi/key
chmod 600 ~/.takibi/key

Use um editor para salvar a chave publicId.secret completa como a única linha em ~/.takibi/key. Não cole o segredo no histórico do shell ou em chat. A conta que roda o agente deve poder ler esse arquivo.

Execute takibi version para verificar a conexão. Essa verificação não precisa de uma chave, então uma resposta de versão bem-sucedida não prova que a chave ou as concessões são válidas. Teste-as com uma pesquisa ou pergunta permitida em seguida.

Se o Perfil tiver uma coleção, a CLI a seleciona automaticamente. Caso contrário, execute takibi projects para ver o que a chave pode alcançar, depois passe --project <name-or-uuid>. Perfis com apenas concessões de tag não listam coleções. Passe um ID de coleção do mesmo workspace explicitamente.

Os nomes resolvem pela API (um nome compartilhado por duas coleções deve usar o UUID); takibi projects --add <name> <uuid> mantém aliases locais para uso offline. Se uma coleção estiver faltando na lista, verifique as configurações de Acesso do Perfil — a lista mostra o escopo concedido, nada mais.

takibi ask -q "What is our refund policy?" --json
takibi search -q "refund eligibility" --json
takibi doc text <document-uuid>

Ask retorna trechos de fonte exatos e citações. Search retorna trechos ranqueados para você encontrar material relevante. Doc text lê o texto convertido permitido de um documento.

Se nenhum trecho voltar, verifique o acesso e o status do documento do Perfil, tente uma pergunta mais estreita, ou pesquise por uma frase específica. Não trate a evidência ausente como uma resposta negativa. Se a etapa de ranqueamento de IA estiver indisponível, os resultados voltam à correspondência simples por palavra-chave. A pesquisa continua funcionando de qualquer forma.

Faça o agente citar os documentos retornados e distinguir a evidência da fonte de sua própria interpretação. Dê aprovação explícita antes de ações que alteram tarefas, depois siga o fluxo de trabalho de tarefas. Agentes arquivam documentos com takibi doc upload <file> --project <name-or-uuid> uma vez que você habilite Envios no Perfil deles e aprove o arquivamento.

Para requisições com falha, veja diagnóstico de erros. Para uma integração direta, use a referência da API e seu download estático do OpenAPI.