Primeiros passos com a extensão do Looker para VS Code

Com a extensão do Looker para VS Code, é possível desenvolver LookML diretamente no seu ambiente de trabalho local. Ele oferece destaque de sintaxe avançado, sincronização bidirecional de arquivos com sua instância do Looker e integração com agentes de programação de IA para "programação de vibe".

A extensão é criada usando o framework do Visual Studio Code (VS Code) e oferece suporte a ambientes de desenvolvimento integrados (IDEs) baseados no IDE do VS Code, como os seguintes IDEs e ferramentas de programação:

Claude Code
Codex
Cursor
Kiro
VS Code
Windsurf
Zed

IDEs que não são forks do VS Code, como IntelliJ e Eclipse, não são compatíveis com a extensão do Looker para VS Code.

Este guia mostra como configurar e autenticar a extensão.

Fluxo de trabalho com tecnologia de IA

A extensão do Looker para VS Code faz parte de um fluxo de trabalho de desenvolvimento de agentes com tecnologia de IA para editar e criar arquivos do LookML. Para ativar esse fluxo de trabalho, configure as seguintes ferramentas:

A extensão do Looker para VS Code.
Um IDE local baseado no VS Code. O IDE precisa ter um agente de IA integrado (por exemplo, Cursor) ou, se não tiver (como o VS Code básico), precisa ser integrado a uma ferramenta de agente independente (como a CLI do Gemini ou o Claude Code). Consulte a documentação do seu ambiente de desenvolvimento integrado local para saber como conectar o ambiente a um agente.
Um servidor MCP, como a MCP Toolbox para bancos de dados.

Para saber mais sobre o fluxo de trabalho com tecnologia de IA, consulte a página de documentação Desenvolvimento assistido por IA (programação de vibe) com o Looker.

Antes de começar

Antes de instalar a extensão, você precisa atender aos seguintes requisitos:

Conectar-se a ferramentas de IA: se você planeja usar o desenvolvimento assistido por IA, conecte seu ambiente de desenvolvimento integrado e seu agente de IA à MCP Toolbox for Databases. Por exemplo, uma configuração de amostra para conectar o MCP Toolbox à CLI do Gemini aparece na documentação Usar o Looker com o MCP, a CLI do Gemini e outros agentes. Consulte a documentação das suas ferramentas para mais detalhes.
Permissões do Looker: você precisa ter a permissão develop do Looker para editar qualquer modelo.
Instância do Looker: sua instância precisa estar executando o Looker 26.6 ou uma versão mais recente.
Instalação do Git: é necessário ter o Git instalado na máquina local para clonar e gerenciar o repositório LookML.
Configuração do projeto: seu projeto do LookML precisa estar configurado para o Git.
ID do cliente OAuth: se você estiver usando a autenticação OAuth (recomendada), peça um ID do cliente OAuth ao administrador do Looker.

Configuração do Administrador

Se a organização usa o OAuth para autenticação, um administrador do Looker precisa registrar a extensão do Looker para VS Code como um cliente OAuth na interface de administrador do Looker.

Use o API Explorer do Looker para configurar a integração do OAuth. É possível acessar o API Explorer usando um dos seguintes métodos:

Se a instância do Looker já tiver o API Explorer instalado, acesse-o com este formato de URL:
```
https://LOOKER_INSTANCE_URL/extensions/marketplace_extension_api_explorer::api-explorer/
```
Se a sua instância do Looker não tiver o API Explorer, instale-o no Marketplace do Looker. Consulte a página Como usar o API Explorer para mais informações.

Para registrar a extensão, siga estas etapas:

Siga as instruções na documentação Registrar um aplicativo cliente OAuth para registrar a extensão.
Para o campo client_guid, siga estas etapas:
- Use qualquer ID exclusivo global.
- Prepare-se para distribuir o ID a todos os desenvolvedores de LookML que quiserem usar a extensão.

Para o redirect_uri, use:

vscode://google.vscode-looker-official/oauth_callback

Conclua display_name e description conforme descrito na documentação Registrar um aplicativo cliente OAuth.

Depois que o app for registrado, o API Explorer vai retornar uma resposta com um resumo do registro. Use o endpoint Get OAuth Client App com o client_guid para revisar os detalhes do registro.

Forneça o client_guid gerado aos desenvolvedores, que vão usá-lo ao configurar a extensão.

Instalar a extensão

Siga estas etapas para instalar a extensão:

Instale a extensão do Looker para VS Code no Visual Studio Marketplace.
Abra seu ambiente de desenvolvimento integrado, como VS Code ou Cursor.
Clique no ícone Extensões na barra de atividades.
Encontre a extensão do Looker para VS Code e clique em Instalar.
Depois que a extensão for instalada, o ícone Looker vai aparecer na barra de atividades.

Configurar a extensão

Configure a extensão com os detalhes da sua instância do Looker no arquivo settings.json do seu espaço de trabalho.

Com um espaço de trabalho aberto, abra a paleta de comandos (Command-Shift-P no Mac ou Ctrl+Shift+P no Windows/Linux).
Procure e selecione Preferências: abrir configurações do espaço de trabalho (JSON).
Adicione as variáveis de configuração às suas configurações. As variáveis de configuração variam de acordo com o método de autenticação (OAuth ou credenciais da API).

Autenticar com o OAuth (recomendado)

O OAuth 2.1 é o fluxo de autenticação recomendado. Cole essas configurações no arquivo settings.json do seu espaço de trabalho.

{
  "looker.instanceUrl": "https://YOUR_INSTANCE_URL",
  "looker.oauthClientId": "YOUR_OAUTH_CLIENT_ID",
  "looker.projectId": "YOUR_PROJECT_ID"
}

Substitua:

https://YOUR_INSTANCE_URL: o URL da sua instância do Looker.
YOUR_OAUTH_CLIENT_ID: o ID do cliente OAuth (client_guid) que você recebe do administrador do Looker.
YOUR_PROJECT_ID: o nome do projeto que você quer editar. Para encontrar, na sua instância do Looker, abra a página Projetos do LookML. O ID do projeto está na coluna Projeto.

Autenticar com credenciais da API

Se preferir usar chaves de API Looker, siga a documentação para criar credenciais de API. Você também precisa informar o ID do projeto.

{
  "looker.instanceUrl": "https://YOUR_INSTANCE_URL",
  "looker.clientId": "YOUR_CLIENT_ID",
  "looker.clientSecret": "YOUR_CLIENT_SECRET",
  "looker.projectId": "YOUR_PROJECT_ID"
}

Substitua:

https://YOUR_INSTANCE_URL: o URL da sua instância do Looker.
YOUR_CLIENT_ID e YOUR_CLIENT_SECRET: o ID e a chave secreta do cliente para as credenciais da API que você está usando para autenticar. Para encontrar essas credenciais, na sua instância do Looker, abra a página Conta. Em seguida, na seção Chaves de API, clique no botão Gerenciar. Isso abre a página Chaves de API, onde você pode conferir os IDs e as chaves secretas do cliente.
YOUR_PROJECT_ID: o nome do projeto que você quer editar. Para encontrar o nome do projeto, na sua instância do Looker, abra a página Projetos do LookML. O ID do projeto está na coluna Projeto.

Configurações

É possível configurar as seguintes opções do MCP no espaço de trabalho do ambiente de desenvolvimento integrado.

Configuração	Descrição	Padrão
`looker.instanceURL`	URL de base da instância do Looker (por exemplo, `https://mycompany.looker.com`).	-
`looker.authURL`	URL a ser usado para autenticação OAuth. Só defina se for diferente do URL da instância.	`looker.instanceURL`
`looker.sdkURL`	URL a ser usado para solicitações de API. Só defina se for diferente do URL da sua instância.	`looker.instanceURL`
`looker.oauthClientId`	ID do cliente OAuth do Looker. Obrigatório para OAuth.	-
`looker.clientId`	ID do cliente da API Looker. Obrigatório para a autenticação com chave de API.	-
`looker.clientSecret`	Chave secreta do cliente da API Looker. Obrigatório para a autenticação com chave de API.	-
`looker.projectId`	ID do projeto do Looker.	-
`looker.mcpServerUrl`	URL do servidor MCP externo a ser usado como proxy (por exemplo, `http://localhost:5000/mcp`).	-
`looker.acceptSelfSignedCertificates`	Ignorar erros de certificado SSL (por exemplo, para certificados autoassinados). Aviso: não recomendamos ativar essa opção.	`false`
`looker.askBeforeOverwritingRemote`	Sempre perguntar antes de substituir arquivos remotos quando um conflito é detectado.	`false`

Autenticar pelo Looker

Se você estiver usando a autenticação OAuth, faça login para vincular seu IDE local à sua conta do Looker.

Abra a paleta de comandos.
Execute o comando: Looker: fazer login (OAuth).
Confirme a solicitação para abrir o navegador.
No navegador, autorize a extensão a acessar sua conta do Looker.
Depois da autorização, o navegador redireciona você de volta para o ambiente de desenvolvimento integrado. Você vai receber uma notificação informando Login no Looker feito com sucesso!

Clonar seu projeto do LookML

Para começar o desenvolvimento, clone o repositório LookML na sua máquina local.

No VS Code, abra uma nova janela.
Abra a paleta de comandos e selecione Git: Clone.
Insira o URL do seu repositório Git remoto (por exemplo, do GitHub ou GitLab) e escolha uma pasta local.
Abra a pasta clonada no seu ambiente de desenvolvimento integrado.

A extensão detecta automaticamente os arquivos LookML e começa a sincronizar com sua ramificação extraída no modo de desenvolvimento da instância do Looker.

Solução de problemas

É possível conferir os registros de extensão no painel Saída do seu ambiente de desenvolvimento integrado. Selecione o canal Looker para ver os registros. Para registros mais detalhados, abra a paleta de comandos, execute o comando Desenvolvedor: definir nível de registro e selecione Depurar ou Trace.

Erros de autenticação: verifique se o looker.instanceUrl e o looker.oauthClientId estão corretos. Verifique se o URI de redirecionamento no Looker corresponde exatamente.
Problemas de sincronização: verifique os registros de extensão para resolver problemas de sincronização. Para ver os registros, abra o painel Saída e selecione Looker no menu suspenso.
Resposta de solicitação inválida durante o OAuth: verifique se a instância do Looker está acessível na sua rede local e se você tem uma conexão de Internet válida.

Se você tiver problemas com a extensão, execute o comando Desenvolvedor: recarregar janela na paleta de comandos para resolver.