Docs Começando Introdução

Introdução ao OrkestraAI

OrkestraAI é a extensão de IDE que orquestra o ciclo de entrega — do ticket ao merge — direto do editor. Esta página cobre instalação, os cinco fluxos disponíveis e as integrações reais que já estão em produção.

i

O que você vai aprenderInstalar a extensão nos IDEs suportados (VS Code, Cursor, Windsurf, Google Antigravity, Kiro), conectar um repositório (GitHub, Bitbucket Cloud, GitLab incl. self-managed) e um provider de tasks (Jira, GitHub Issues, Azure DevOps, ClickUp), e rodar qualquer um dos cinco fluxos pelo webview ou pelos atalhos.

Instalação

Identificador no Marketplace: DjAlexDee.orkestra-ai. Requer VS Code ≥ 1.80.0 (ou build compatível de Cursor, Windsurf, Antigravity, Kiro).

# 1. Command Palette (⌘⇧P) → Extensions: Install Extensions
# 2. Procure por “OrkestraAI”
#     ou via CLI:
$ code --install-extension orkestraai.orkestra
$ cursor --install-extension orkestraai.orkestra

# 3. Recarregue a janela e clique no ícone ◬ na activity bar

Quick start

Após instalar, abra um repositório Git, clique no ícone Orkestra na activity bar, configure pelo menos um provider em orkestra.provider, e selecione uma task no board.

Os 5 fluxos disponíveis

A extensão expõe múltiplos fluxos que reutilizam os mesmos passos atômicos. Cada fluxo difere em sequência e em quantos checkpoints pede confirmação humana.

// Fluxo · Entry point · Steps · Checkpoints
1. Start (board)           // 1 checkpoint (escolhe modo)
2. Quick Start             // Refine → Start → Implement
3. Full linear              // 8 passos canônicos, sem pausa
4. Full com checkpoints     // 8 passos · 2 pausas (PR + auto-fix)
5. Aha Moment              // Refine → Start → Implement → Create PR

Os 8 passos canônicos do pipeline completo:

  • 1. Refine — IA + scanner do repo → descrição, critérios, riscos
  • 2. Startmove task para 'em progresso' + snapshot do repo
  • 3. Implementprompt estruturado no editor
  • 4. Create PRcria/encontra PR no SCM
  • 5. Sync PR commentssincroniza thread de review (sem IA)
  • 6. AI Review PRanálise IA do diff (billable)
  • 7. Auto Fix PRcorreções acima do limiar, commit em lote opcional
  • 8. Finish Taskfecha o ciclo no provider

Atalhos de teclado

Com foco no editor (editorTextFocus). Comandos legados devTask.* ainda apontam para os mesmos handlers.

Ctrl/Cmd+Shift+1 → orkestra.refineTask           // Refinar task
Ctrl/Cmd+Shift+2 → orkestra.startAndImplementTask // Iniciar e implementar
Ctrl/Cmd+Shift+3 → orkestra.implementTask         // Implementar com IA
Ctrl/Cmd+Shift+4 → orkestra.review                // Revisar PR com IA
Ctrl/Cmd+Shift+5 → orkestra.finishTask            // Finalizar task
Ctrl/Cmd+Shift+6 → orkestra.runWorkflow           // Rodar fluxo completo

Providers de tasks

Configurados via orkestra.provider e os respectivos namespaces (orkestra.jira.*, orkestra.azure.*, orkestra.clickup.*, etc.). OAuth e PAT são suportados, com redirect padrão http://localhost:4567/callback.

  • Jira — basic + OAuth
  • GitHub Issues
  • Azure DevOps
  • ClickUp — token pessoal ou OAuth

Providers de Git / PR

  • GitHuborkestra.github.*
  • Bitbucket Cloudorkestra.bitbucket.*
  • GitLaborkestra.gitlab.token; para self-managed defina orkestra.gitlab.instanceHost com o hostname do seu GitLab on-prem

Webhooks de entrada e saída

A Orkestra recebe eventos de PR/issues/comentários do GitHub, Bitbucket, Jira e ClickUp em tempo real (sem polling) através do canal cloud — o webview atualiza sozinho. Para o caminho contrário, planos Pro+ podem disparar notificações outbound para Slack, Discord ou qualquer endpoint HTTPS quando uma task muda de estado.

Já em produçãoInbound webhooks são parte do contrato cloud (POST /v1/webhooks/:provider/:tenantToken). Outbound webhooks são uma feature flag do plano Pro+ (outboundWebhooks).

Em breve

  • Monday.com5º provider de tasks
  • Figmaanexar frames e specs ao refine
  • Conectores MCPModel Context Protocol para plugar ferramentas externas

Settings — namespace orkestra.*

Todas as configurações usam o prefixo orkestra (ex. orkestra.provider, orkestra.jira.domain). Se você atualizou de uma versão que usava devTaskAssistant.*, a extensão copia os valores na primeira ativação.

// settings.json
{
  "orkestra.provider": "jira",
  "orkestra.uiLanguage": "auto",    // auto | pt-br | en
  "orkestra.sync.enable": true,
  "orkestra.gitlab.token": "glpat-…",
  "orkestra.gitlab.instanceHost": "gitlab.acme.com"
}

API HTTP embutida (porta 19850)

A extensão expõe uma API local em 127.0.0.1:19850 (nunca pública) para automações e integrações. Em produção exige JWT/API key; o WebSocket exige credencial.

Billing & quotas

O backend cloud (NestJS + Prisma + PostgreSQL) implementa checkout multi-gateway (Stripe + Asaas) com webhooks idempotentes. As quotas (ações IA/dia, workflow runs/mês, auto-fix prompts/mês) são validadas antes de cada chamada ao motor; o catálogo de planos vive em src/saas/planCatalog/plan-definitions.ts.

Self-host / Enterprise

Para times com requisitos de compliance: VPC dedicado, BYOK com KMS, SSO SAML, SCIM provisioning, audit logs em S3 Object Lock. Falar com vendas →

!

Versão atual: 1.3.8Esta documentação reflete o código em produção. Em caso de divergência entre site e repositório, o repositório prevalece.