Mulai menggunakan ekstensi Looker untuk VS Code

Ekstensi Looker untuk VS Code memungkinkan Anda mengembangkan LookML langsung dalam lingkungan desktop lokal. Editor ini menyediakan penyorotan sintaksis yang kaya, sinkronisasi file dua arah dengan instance Looker Anda, dan integrasi dengan agen coding AI untuk "coding suasana".

Ekstensi ini dibuat menggunakan framework Visual Studio Code (VS Code), dan mendukung IDE yang berbasis VS Code IDE, seperti IDE dan alat coding berikut:

  • Claude Code
  • Codex
  • Kursor
  • Kiro
  • VS Code
  • Windsurf
  • Zed

IDE yang bukan fork VS Code, seperti IntelliJ dan Eclipse, tidak didukung oleh ekstensi Looker untuk VS Code.

Panduan ini membahas cara menyiapkan dan mengautentikasi ekstensi.

Alur kerja yang didukung AI

Ekstensi Looker untuk VS Code adalah bagian dari alur kerja pengembangan agentik yang didukung AI untuk mengedit dan membuat file LookML. Untuk mengaktifkan alur kerja ini, konfigurasi alat berikut:

  • Ekstensi Looker untuk VS Code.
  • IDE lokal yang berbasis VS Code. IDE harus berisi agen AI bawaan (misalnya, Cursor), atau, jika IDE tidak berisi agen AI bawaan (seperti VS Code dasar), IDE harus terintegrasi dengan alat agentik mandiri (seperti Gemini CLI atau Claude Code). Lihat dokumentasi IDE lokal Anda untuk mengetahui cara menghubungkan IDE ke agen.
  • Server MCP, seperti MCP Toolbox for Databases.

Untuk mempelajari lebih lanjut alur kerja yang didukung AI, lihat halaman dokumentasi Pengembangan yang dibantu AI (coding nuansa) dengan Looker.

Sebelum memulai

Sebelum menginstal ekstensi, Anda harus memenuhi persyaratan berikut:

  • Menghubungkan ke alat AI: Jika Anda berencana menggunakan pengembangan yang dibantu AI, hubungkan IDE dan agen AI Anda ke MCP Toolbox for Databases. Sebagai contoh, konfigurasi sampel untuk menghubungkan MCP Toolbox ke Gemini CLI muncul dalam dokumentasi Menggunakan Looker dengan MCP, Gemini CLI, dan agen lainnya. Lihat dokumentasi alat Anda untuk mengetahui detail tambahan.
  • Izin Looker: Anda harus memiliki izin Looker develop untuk model yang ingin Anda edit.
  • Instance Looker: Instance Anda harus menjalankan Looker 26.6 atau yang lebih baru.
  • Penginstalan Git: Anda harus menginstal Git di komputer lokal untuk meng-clone dan mengelola repositori LookML.
  • Konfigurasi project: Project LookML Anda harus dikonfigurasi untuk Git.
  • Client ID OAuth: Jika Anda menggunakan autentikasi OAuth (direkomendasikan), Anda harus mendapatkan Client ID OAuth dari admin Looker Anda.

Penyiapan admin

Jika organisasi Anda menggunakan OAuth untuk autentikasi, admin Looker harus mendaftarkan ekstensi Looker untuk VS Code sebagai klien OAuth di UI Admin Looker.

Gunakan API Explorer Looker untuk menyiapkan integrasi OAuth. Anda dapat mengakses API Explorer menggunakan salah satu metode berikut:

  • Jika instance Looker Anda sudah menginstal API Explorer, Anda dapat mengaksesnya dengan format URL ini:

    https://LOOKER_INSTANCE_URL/extensions/marketplace_extension_api_explorer::api-explorer/

  • Jika instance Looker Anda tidak memiliki API Explorer, Anda dapat menginstalnya dari Looker Marketplace. Lihat halaman Menggunakan API Explorer untuk mengetahui informasinya.

Untuk mendaftarkan ekstensi, selesaikan langkah-langkah berikut:

  1. Ikuti petunjuk dalam dokumentasi Mendaftarkan aplikasi klien OAuth untuk mendaftarkan ekstensi.

  2. Untuk kolom client_guid, selesaikan langkah-langkah berikut:

    • Gunakan ID unik secara global.
    • Bersiaplah untuk mendistribusikan ID kepada developer LookML yang ingin menggunakan ekstensi.

  3. Untuk redirect_uri, gunakan:

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

  4. Selesaikan display_name dan description seperti yang dijelaskan dalam dokumentasi Mendaftarkan aplikasi klien OAuth.

Setelah aplikasi didaftarkan, API Explorer akan menampilkan respons dengan ringkasan pendaftaran. Anda dapat menggunakan endpoint Get OAuth Client App dengan client_guid untuk meninjau detail pendaftaran Anda.

Berikan client_guid yang dihasilkan kepada developer Anda; mereka akan menggunakannya saat mengonfigurasi ekstensi.

Menginstal ekstensi

Selesaikan langkah-langkah berikut untuk menginstal ekstensi:

  1. Instal ekstensi Looker untuk VS Code dari Visual Studio Marketplace.
  2. Buka IDE Anda, seperti VS Code atau Cursor.
  3. Klik ikon Ekstensi di Panel Aktivitas.
  4. Temukan ekstensi Looker untuk VS Code, lalu klik Install.
  5. Setelah ekstensi diinstal, ikon Looker akan muncul di Activity Bar.

Mengonfigurasi ekstensi

Anda harus mengonfigurasi ekstensi dengan detail instance Looker di file settings.json ruang kerja Anda.

  1. Dengan ruang kerja terbuka, buka Palet Perintah (Command-Shift-P di Mac atau Ctrl+Shift+P di Windows/Linux).
  2. Telusuri dan pilih Preferences: Open Workspace Settings (JSON).
  3. Tambahkan variabel konfigurasi ke setelan Anda. Variabel konfigurasi akan bervariasi, bergantung pada apakah metode autentikasi Anda adalah OAuth atau kredensial API.

OAuth 2.1 adalah alur autentikasi yang direkomendasikan. Tempelkan setelan ini di file settings.json ruang kerja Anda.

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

Ganti kode berikut:

  • https://YOUR_INSTANCE_URL: URL instance Looker Anda.
  • YOUR_OAUTH_CLIENT_ID: ID klien OAuth (client_guid) yang Anda terima dari admin Looker.
  • YOUR_PROJECT_ID: Nama project yang ingin Anda edit. Untuk menemukannya, di dalam instance Looker Anda, buka halaman LookML Projects. Project ID ada di kolom Project.

Melakukan autentikasi dengan kredensial API

Jika Anda lebih memilih menggunakan kunci API Looker, ikuti dokumentasi untuk membuat kredensial API. Anda juga harus memberikan project ID Anda.

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

Ganti kode berikut:

  • https://YOUR_INSTANCE_URL: URL instance Looker Anda.
  • YOUR_CLIENT_ID dan YOUR_CLIENT_SECRET: Client ID dan rahasia klien untuk kredensial API yang Anda gunakan untuk melakukan autentikasi. Untuk menemukan kredensial ini, di dalam instance Looker Anda, buka halaman Akun; lalu, di bagian Kunci API, klik tombol Kelola. Tindakan ini akan membuka halaman Kunci API tempat Anda dapat melihat client ID dan secret.
  • YOUR_PROJECT_ID: Nama project yang ingin Anda edit. Untuk menemukan nama project, di dalam instance Looker Anda, buka halaman LookML Projects. Project ID ada di kolom Project.

Setelan

Anda dapat mengonfigurasi setelan MCP berikut di ruang kerja IDE Anda.

Setelan Deskripsi Default
looker.instanceURL URL dasar instance Looker (misalnya, https://mycompany.looker.com). -
looker.authURL URL yang akan digunakan untuk autentikasi OAuth. Hanya ditetapkan jika berbeda dengan URL instance Anda. looker.instanceURL
looker.sdkURL URL yang akan digunakan untuk permintaan API. Hanya ditetapkan jika berbeda dengan URL instance Anda. looker.instanceURL
looker.oauthClientId ID Klien OAuth Looker. Diperlukan untuk OAuth. -
looker.clientId ID Klien Looker API. Diperlukan untuk autentikasi Kunci API. -
looker.clientSecret Rahasia Klien Looker API. Diperlukan untuk autentikasi Kunci API. -
looker.projectId ID Project Looker. -
looker.mcpServerUrl URL server MCP eksternal yang akan di-proxy (misalnya, http://localhost:5000/mcp). -
looker.acceptSelfSignedCertificates Abaikan error sertifikat SSL (misalnya, untuk sertifikat yang ditandatangani sendiri). Peringatan: Sebaiknya jangan aktifkan opsi ini. false
looker.askBeforeOverwritingRemote Selalu tanyakan sebelum mengganti file jarak jauh saat konflik terdeteksi. false

Melakukan autentikasi melalui Looker

Jika menggunakan autentikasi OAuth, Anda harus login untuk menautkan IDE lokal ke akun Looker Anda.

  1. Buka Palet Perintah.
  2. Jalankan perintah: Looker: Sign In (OAuth).
  3. Konfirmasi perintah untuk membuka browser Anda.
  4. Di browser, izinkan ekstensi untuk mengakses akun Looker Anda.
  5. Setelah memberikan otorisasi, browser akan dialihkan kembali ke IDE Anda. Anda akan melihat notifikasi yang menyatakan Berhasil login ke Looker!

Meng-clone project LookML

Untuk memulai pengembangan, Anda harus meng-clone repositori LookML ke komputer lokal.

  1. Di VS Code, buka jendela baru.
  2. Buka Palet Perintah dan pilih Git: Clone.
  3. Masukkan URL repositori Git jarak jauh Anda (misalnya, dari GitHub atau GitLab) dan pilih folder lokal.
  4. Buka folder yang di-clone di IDE Anda.

Ekstensi ini otomatis mendeteksi file LookML dan mulai menyinkronkan dengan cabang yang di-checkout di Mode Pengembangan instance Looker Anda.

Pemecahan masalah

Anda dapat melihat log ekstensi di panel Output IDE. Pilih saluran Looker untuk melihat log. Untuk log yang lebih mendetail, buka Palet Perintah, jalankan perintah Developer: Set Log Level, lalu pilih Debug atau Trace.

  • Error autentikasi: Pastikan looker.instanceUrl dan looker.oauthClientId Anda sudah benar. Pastikan URI pengalihan di Looker cocok persis.
  • Masalah sinkronisasi: Periksa log ekstensi untuk mengatasi masalah sinkronisasi. Untuk melihat log, buka panel Output dan pilih Looker dari menu drop-down.
  • Respons Permintaan Buruk selama OAuth: Pastikan instance Looker Anda dapat diakses dari jaringan lokal dan Anda memiliki koneksi internet yang valid.

Jika Anda mengalami masalah dengan ekstensi, menjalankan perintah Developer: Reload Window dari Palet Perintah dapat membantu menyelesaikannya.

Langkah berikutnya