Mulai proyek dengan /init dan AGENTS.md di Bob Shell

Jalankan perintah /init Bob Shell untuk menghasilkan AGENTS.md, file konteks proyek yang dimuat Bob dalam setiap percakapan, dan pelajari cara menjaga konteks tersebut tetap terkini.

Perintah /init memindai proyek dan menghasilkan file ringkasan terstruktur bernama AGENTS.md yang digunakan Bob sebagai konteks persisten dalam setiap percakapan. Perintah /init adalah cara kamu memberikan pengetahuan kepada Bob tentang struktur, konvensi, dan codebase suatu proyek—tanpa mengharuskan Bob membaca ulang setiap file di awal setiap interaksi.

Large language model bersifat stateless. Setiap percakapan baru dimulai tanpa memori interaksi sebelumnya. Tanpa konteks proyek yang eksplisit, Bob harus menemukan kembali codebase di setiap interaksi baru, yang tidak efisien dan menjadi tidak praktis pada skala besar.

Dalam tutorial ini, kamu menginisialisasi Bob Shell di direktori root aplikasi demo, menjelajahi konteks yang diperoleh Bob tentang aplikasi tersebut, dan mempelajari cara Bob Shell memuat file AGENTS.md.

Prasyarat

Untuk menyelesaikan tutorial ini, kamu memerlukan:

  • Jika belum memilikinya, clone demo Galaxium Travels. Perintah clone ini juga memeriksa bob-learning-path-branch yang berisi kode yang digunakan dalam tutorial.
    git clone -b bob-learning-path-branch https://github.com/IBM/galaxium-travels
  • Meski tidak wajib, pertimbangkan untuk membaca Memulai sesi interaktif agar lebih familiar dengan antarmuka dan fitur Bob Shell.

Mulai Bob Shell di proyek

Pindah ke direktori root Galaxium Travels:

cd galaxium-travels

Mulai sesi interaktif:

bob chat --mode agent

Flag --mode agent memulai sesi dalam mode Agent, yang memiliki tool yang dibutuhkan Bob untuk membaca file dan menulis AGENTS.md.

Jika Bob Shell bertanya apakah kamu mempercayai folder tersebut, percayai agar Bob dapat bekerja di proyek. Untuk mempelajari lebih lanjut, lihat Folder yang dipercaya.

Hasilkan AGENTS.md dengan /init

Masukkan perintah /init di prompt:

/init

Bob membaca file-file yang relevan dalam proyek.

Ketika Bob meminta untuk menggunakan tool, seperti membaca file atau menulis AGENTS.md, dialog persetujuan akan muncul. Pilih Approve untuk setiap permintaan.

Bob menghasilkan file AGENTS.md utama di direktori root Galaxium Travels. Bob juga menghasilkan file konteks spesifik mode di .bob/rules-agent/AGENTS.md, .bob/rules-ask/AGENTS.md, dan .bob/rules-plan/AGENTS.md.

Jelajahi file AGENTS.md

File AGENTS.md adalah dokumentasi onboarding untuk Bob. Ini adalah ringkasan singkat dan actionable yang menyediakan semua yang dibutuhkan Bob untuk memahami struktur dan konvensi proyek.

Minta Bob untuk menampilkan file tersebut:

Show me the contents of @AGENTS.md

Simbol @ mereferensikan file dalam proyekmu, sehingga Bob membacanya sebelum merespons. Kamu juga dapat membuka terminal lain dan melihat file secara langsung:

cat AGENTS.md

File AGENTS.md biasanya berisi komponen-komponen berikut:

  • Ikhtisar dan tujuan proyek
  • Struktur direktori dan lokasi file utama
  • Technology stack dan dependensi
  • Pola arsitektur dan konvensi
  • Alur kerja pengembangan

Untuk melihat semua file yang dibuat oleh /init, jalankan git status di direktori Galaxium Travels:

git status

Cara Bob Shell memuat file AGENTS.md

Bob Shell secara otomatis memuat file konteks seperti AGENTS.md di awal setiap task.

  1. Konteks global: ~/.bob/AGENTS.md berlaku untuk semua proyek.
  2. Konteks proyek: AGENTS.md di root proyek dan direktori induk berlaku untuk proyek.
  3. Konteks lokal: AGENTS.md di subdirektori berlaku untuk subdirektori tersebut, untuk instruksi spesifik komponen.

Untuk memberikan Bob instruksi untuk satu mode tertentu, tambahkan aturan spesifik mode di direktori .bob/rules-<mode>/, seperti .bob/rules-plan/ untuk mode Plan.

Jaga file AGENTS.md tetap terkini

Jalankan ulang /init setelah perubahan berikut:

  • Menambahkan modul atau layanan baru
  • Mengubah struktur direktori
  • Mengadopsi teknologi atau framework baru
  • Menyambut anggota tim baru yang menggunakan Bob

Kamu juga dapat mengedit AGENTS.md secara manual untuk menambahkan konteks yang mungkin tidak ditangkap oleh pemindaian otomatis Bob, seperti aturan bisnis, konvensi deployment, atau praktik spesifik tim. Commit AGENTS.md ke version control agar timmu berbagi konteks yang sama.

Langkah berikutnya

Dalam tutorial ini, kamu telah mempelajari hal-hal berikut:

  • Large language model bersifat stateless. Menjalankan perintah /init mengatasi masalah ini dengan menghasilkan AGENTS.md, yaitu file konteks persisten yang dibaca Bob di awal setiap percakapan.
  • Jalankan ulang /init setelah perubahan proyek besar untuk menjaga konteks tetap terkini.

Lanjutkan ke Tulis prompt yang efektif untuk Bob Shell untuk mempelajari cara menulis prompt yang secara andal menghasilkan output yang kamu inginkan.

Bagaimana topik ini?