Samouczki

Rozpocznij projekt z /init i AGENTS.md

Zapewnij Bobowi trwały kontekst projektu w rozmowach i trybach za pomocą /init, który automatycznie generuje pliki AGENTS.md.

Polecenie /init skanuje projekt i generuje uporządkowany plik podsumowania o nazwie AGENTS.md, którego Bob używa jako trwałego kontekstu w każdej rozmowie. Polecenie /init to sposób, w jaki przekazujesz Bobowi wiedzę o strukturze, konwencjach i bazie kodu projektu, bez wymagania od Boba ponownego odczytywania każdego pliku na początku każdej interakcji.

Duże modele językowe są bezstanowe. Każda nowa rozmowa rozpoczyna się bez pamięci poprzednich interakcji. Bez wyraźnego kontekstu projektu Bob musi odkrywać bazę kodu przy każdej nowej interakcji, co jest nieefektywne i staje się niepraktyczne na dużą skalę.

W tym samouczku inicjalizujesz Boba w katalogu głównym aplikacji demonstracyjnej, eksplorujesz kontekst, który Bob uzyskuje o aplikacji, i uczysz się o strukturze Boba dla kontekstu specyficznego dla trybu.

Wymagania wstępne

Aby ukończyć ten samouczek, potrzebujesz następujących elementów:

  • Jeśli jeszcze tego nie masz, sklonuj kod demonstracyjny Galaxium Travels. Polecenie klonowania sprawdza również gałąź bob-learning-path-branch, która zawiera kod używany w samouczkach.
git clone -b bob-learning-path-branch https://github.com/IBM/galaxium-travels
  • Bob IDE z otwartym kodem demonstracyjnym Galaxium Travels
  • Chociaż nie jest to wymagane, rozważ wykonanie samouczka szybkiego startu, aby zapoznać się z interfejsem i funkcjami Boba.

Uruchom /init

Aby zainicjować kontekst projektu, przejdź do interfejsu czatu Cześć, jestem Bob w IDE Boba. Przełącz się na tryb Agent na dole paska bocznego.

Przełącz na tryb Agent

Wprowadź polecenie /init w interfejsie czatu. Jeśli masz wyłączone automatyczne zatwierdzanie, Bob poprosi o pozwolenie na odczytanie plików i zapisanie plików AGENTS.md.

 /init

Uruchamianie polecenia /init w IDE Boba

Bob odczytuje odpowiednie pliki w projekcie. Następnie Bob generuje główny plik AGENTS.md w katalogu głównym Galaxium Travels. Bob tworzy również folder .bob, który zawiera AGENTS.md dla każdego trybu.

Eksploruj pliki AGENTS.md

Pliki AGENTS.md działają jak dokumentacja wdrożeniowa dla Boba. AGENTS.md to zwięzłe, wykonalne podsumowanie, które zapewnia wszystko, czego Bob potrzebuje, aby zrozumieć strukturę i konwencje projektu.

Możesz zlokalizować główny plik AGENTS.md na dole eksploratora plików Boba po lewej stronie. Otwórz plik, aby przeczytać jego zawartość.

Plik AGENTS.md w eksploratorze plików Boba

Plik AGENTS.md zazwyczaj zawiera następujące komponenty:

  • Przegląd i cel projektu
  • Struktura katalogów i lokalizacje kluczowych plików
  • Stos technologiczny i zależności
  • Wzorce architektoniczne i konwencje
  • Przepływy pracy programistycznej

Bob automatycznie stosuje AGENTS.md do nowych rozmów i uczy się kontekstu projektu.

Pliki AGENTS.md specyficzne dla trybu

Oprócz głównego AGENTS.md w katalogu głównym Galaxium Travels, /init generuje pliki kontekstu specyficzne dla trybu w folderze .bob dla każdego wbudowanego trybu. Każdy plik AGENTS.md specyficzny dla trybu rozszerza główny AGENTS.md o kontekst istotny dla celu tego trybu. Poniższa tabela zawiera pliki AGENTS.md specyficzne dla trybu:

PlikTryb
.bob/rules-code/AGENTS-code.mdTryb Agent
.bob/rules-plan/AGENTS-plan.mdTryb Plan
.bob/rules-ask/AGENTS-ask.mdTryb Ask

Kontekst trybu Plan podkreśla konwencje architektoniczne, podczas gdy kontekst trybu Code wyróżnia strukturę plików i wzorce nazewnictwa.

Utrzymuj pliki AGENTS.md

Uruchom ponownie /init po dokonaniu następujących dostosowań projektu:

  • Dodawanie nowych modułów lub usług
  • Zmiana struktury katalogów
  • Przyjęcie nowych technologii lub frameworków
  • Wdrażanie nowych członków zespołu, którzy będą używać Boba

Możesz również ręcznie edytować AGENTS.md, aby dodać kontekst, którego automatyczne skanowanie Boba może nie uchwycić, takie jak reguły biznesowe, konwencje wdrażania lub praktyki specyficzne dla zespołu.

Następne kroki

W tym samouczku dowiedziałeś się:

  • Duże modele językowe są bezstanowe. Uruchomienie polecenia /init rozwiązuje ten problem, generując AGENTS.md, który jest trwałym plikiem kontekstu odczytywanym przez Boba na początku każdej rozmowy.
  • Pliki AGENTS.md specyficzne dla trybu zapewniają ukierunkowany kontekst dla trybów Agent, Plan i Ask.
  • Uruchom ponownie /init po większych zmianach w projekcie, aby utrzymać kontekst na bieżąco.
Jak oceniasz ten temat?