Rozpocznij projekt z /init i AGENTS.md w Bob Shell

Uruchom polecenie /init w Bob Shell, aby wygenerować AGENTS.md — plik kontekstu projektu ładowany przez Boba w każdej rozmowie — i dowiedz się, jak utrzymywać ten kontekst aktualnym.

Polecenie /init skanuje projekt i generuje plik podsumowania strukturalnego o nazwie AGENTS.md, którego Bob używa jako trwałego kontekstu w każdej rozmowie. Polecenie /init to sposób na przekazanie Bobowi wiedzy o strukturze projektu, konwencjach i bazie kodu — bez konieczności ponownego czytania każdego pliku na początku każdej interakcji.

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

W tym samouczku zainicjujesz Bob Shell w katalogu głównym demo aplikacji, zbadasz kontekst, który Bob uzyskuje o aplikacji, i dowiesz się, jak Bob Shell ładuje pliki AGENTS.md.

Wymagania wstępne

Aby ukończyć ten samouczek, potrzebujesz:

  • Jeśli jeszcze tego nie zrobiłeś, sklonuj demo kod Galaxium Travels. Polecenie clone sprawdza również gałąź bob-learning-path-branch zawierającą kod używany w samouczkach.
    git clone -b bob-learning-path-branch https://github.com/IBM/galaxium-travels
  • Choć nie jest to wymagane, rozważ przeczytanie Uruchamianie sesji interaktywnej, aby zapoznać się z interfejsem i funkcjami Bob Shell.

Uruchom Bob Shell w projekcie

Przejdź do katalogu głównego Galaxium Travels:

cd galaxium-travels

Uruchom sesję interaktywną:

bob chat --mode agent

Flaga --mode agent uruchamia sesję w trybie Agent, który posiada narzędzia potrzebne Bobowi do czytania plików i pisania AGENTS.md.

Jeśli Bob Shell zapyta, czy ufasz folderowi, zaufaj mu, aby Bob mógł pracować w projekcie. Aby dowiedzieć się więcej, zapoznaj się z Zaufane foldery.

Wygeneruj AGENTS.md za pomocą /init

Wprowadź polecenie /init w wierszu poleceń:

/init

Bob odczytuje odpowiednie pliki w projekcie.

Gdy Bob poprosi o użycie narzędzia, na przykład czytania plików lub pisania AGENTS.md, pojawi się okno zatwierdzenia. Wybierz Approve dla każdego żądania.

Bob generuje główny plik AGENTS.md w katalogu głównym Galaxium Travels. Generuje również pliki kontekstu specyficzne dla trybów w .bob/rules-agent/AGENTS.md, .bob/rules-ask/AGENTS.md i .bob/rules-plan/AGENTS.md.

Eksploruj pliki AGENTS.md

Plik AGENTS.md to dokumentacja wdrożeniowa dla Boba. Jest to zwięzłe, praktyczne podsumowanie zawierające wszystko, czego Bob potrzebuje, aby zrozumieć strukturę i konwencje projektu.

Poproś Boba o pokazanie pliku:

Show me the contents of @AGENTS.md

Symbol @ odwołuje się do pliku w twoim projekcie, więc Bob czyta go przed odpowiedzią. Możesz też otworzyć inny terminal i wyświetlić plik bezpośrednio:

cat AGENTS.md

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

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

Aby zobaczyć każdy plik utworzony przez /init, uruchom git status w katalogu Galaxium Travels:

git status

Jak Bob Shell ładuje pliki AGENTS.md

Bob Shell automatycznie ładuje pliki kontekstu takie jak AGENTS.md na początku każdego zadania.

  1. Kontekst globalny: ~/.bob/AGENTS.md dotyczy wszystkich projektów.
  2. Kontekst projektu: AGENTS.md w katalogu głównym projektu i katalogach nadrzędnych dotyczy projektu.
  3. Kontekst lokalny: AGENTS.md w podkatalogach dotyczy tego podkatalogu, dla instrukcji specyficznych dla komponentu.

Aby przekazać Bobowi instrukcje dla jednego trybu, dodaj reguły specyficzne dla trybu w katalogach .bob/rules-<mode>/, takich jak .bob/rules-plan/ dla trybu Plan.

Utrzymuj pliki AGENTS.md

Uruchom ponownie /init po następujących zmianach:

  • Dodanie nowych modułów lub usług
  • Zmiana struktury katalogów
  • Przyjęcie nowych technologii lub frameworków
  • Wdrożenie nowych członków zespołu korzystających z Boba

Możesz też ręcznie edytować AGENTS.md, aby dodać kontekst, którego automatyczne skanowanie Boba może nie uchwycić, takie jak reguły biznesowe, konwencje wdrożeniowe lub praktyki specyficzne dla zespołu. Zatwierdź AGENTS.md w kontroli wersji, aby twój zespół korzystał z tego samego kontekstu.

Następne kroki

W tym samouczku nauczyłeś się:

  • Duże modele językowe są bezstanowe. Uruchomienie polecenia /init rozwiązuje ten problem, generując AGENTS.md — trwały plik kontekstu, który Bob czyta na początku każdej rozmowy.
  • Uruchamiaj ponownie /init po większych zmianach w projekcie, aby utrzymać kontekst aktualnym.

Przejdź do Pisanie skutecznych promptów dla Bob Shell, aby dowiedzieć się, jak pisać prompty, które niezawodnie generują pożądany output.

Jak oceniasz ten temat?