Avviare un progetto con /init e AGENTS.md in Bob Shell
Esegui il comando /init di Bob Shell per generare AGENTS.md, un file di contesto del progetto che Bob carica in ogni conversazione, e impara come mantenere quel contesto aggiornato.
Il comando /init scansiona un progetto e genera un file di riepilogo strutturato chiamato AGENTS.md che Bob usa come contesto persistente in ogni conversazione. Il comando /init è il modo in cui dai a Bob la conoscenza della struttura, delle convenzioni e della codebase di un progetto, senza richiedere a Bob di rileggere ogni file all'inizio di ogni interazione.
I large language model sono privi di stato. Ogni nuova conversazione inizia senza alcun ricordo delle interazioni precedenti. Senza un contesto esplicito del progetto, Bob deve riscoprire la codebase a ogni nuova interazione, il che è inefficiente e diventa impraticabile su larga scala.
In questo tutorial inizializzi Bob Shell nella directory radice di un'applicazione demo, esplori il contesto che Bob acquisisce sull'applicazione e impari come Bob Shell carica i file AGENTS.md.
Prerequisiti
Per completare questo tutorial, hai bisogno di:
Bob Shell
Installa Bob Shell v2.x o versione successiva e accedi.
Git
Installa Git per clonare il repository di esempio.
- Se non lo hai già, clona il codice demo Galaxium Travels. Il comando clone esegue anche il checkout del branch
bob-learning-path-branchche contiene il codice usato nei tutorial.git clone -b bob-learning-path-branch https://github.com/IBM/galaxium-travels - Pur non essendo obbligatorio, considera di leggere Avviare una sessione interattiva per familiarizzare con l'interfaccia e le funzionalità di Bob Shell.
Avviare Bob Shell nel progetto
Passa alla directory radice di Galaxium Travels:
cd galaxium-travelsAvvia una sessione interattiva:
bob chat --mode agentIl flag --mode agent avvia la sessione in modalità Agent, che dispone degli strumenti necessari a Bob per leggere i file e scrivere AGENTS.md.
Se Bob Shell chiede se ti fidi della cartella, fiducia la cartella affinché Bob possa lavorare nel progetto. Per saperne di più, consulta Cartelle affidabili.
Generare AGENTS.md con /init
Inserisci il comando /init al prompt:
/initBob legge i file rilevanti nel progetto.
Quando Bob chiede di usare uno strumento, come leggere file o scrivere AGENTS.md, appare il dialogo di approvazione. Seleziona Approve per ogni richiesta.
Bob genera il file AGENTS.md principale nella directory radice di Galaxium Travels. Genera anche file di contesto specifici per modalità in .bob/rules-agent/AGENTS.md, .bob/rules-ask/AGENTS.md e .bob/rules-plan/AGENTS.md.
Esplorare i file AGENTS.md
Il file AGENTS.md è la documentazione di onboarding per Bob. È un riepilogo conciso e operativo che fornisce tutto ciò di cui Bob ha bisogno per comprendere la struttura e le convenzioni del progetto.
Chiedi a Bob di mostrarti il file:
Show me the contents of @AGENTS.mdIl simbolo @ fa riferimento a un file nel tuo progetto, quindi Bob lo legge prima di rispondere. Puoi anche aprire un altro terminale e visualizzare il file direttamente:
cat AGENTS.mdIl file AGENTS.md contiene tipicamente i seguenti componenti:
- Panoramica e scopo del progetto
- Struttura delle directory e posizioni dei file principali
- Stack tecnologico e dipendenze
- Pattern architetturali e convenzioni
- Workflow di sviluppo
Per vedere ogni file creato da /init, esegui git status nella directory Galaxium Travels:
git statusCome Bob Shell carica i file AGENTS.md
Bob Shell carica automaticamente i file di contesto come AGENTS.md all'inizio di ogni task.
- Contesto globale:
~/.bob/AGENTS.mdsi applica a tutti i progetti. - Contesto del progetto:
AGENTS.mdnella radice del progetto e nelle directory superiori si applica al progetto. - Contesto locale:
AGENTS.mdnelle sottodirectory si applica a quella sottodirectory, per istruzioni specifiche del componente.
Per dare a Bob istruzioni per una singola modalità, aggiungi regole specifiche per modalità nelle directory .bob/rules-<modalità>/, come .bob/rules-plan/ per la modalità Plan.
Mantenere aggiornati i file AGENTS.md
Riesegui /init dopo le seguenti modifiche:
- Aggiunta di nuovi moduli o servizi
- Modifica della struttura delle directory
- Adozione di nuove tecnologie o framework
- Onboarding di nuovi membri del team che usano Bob
Puoi anche modificare manualmente AGENTS.md per aggiungere contesto che la scansione automatica di Bob potrebbe non rilevare, come regole di business, convenzioni di deployment o pratiche specifiche del team. Fai il commit di AGENTS.md nel controllo versione in modo che il tuo team condivida lo stesso contesto.
Passi successivi
In questo tutorial hai imparato quanto segue:
- I large language model sono privi di stato. Eseguire il comando
/initrisolve questo problema generandoAGENTS.md, un file di contesto persistente che Bob legge all'inizio di ogni conversazione. - Riesegui
/initdopo importanti modifiche al progetto per mantenere il contesto aggiornato.
Passa a Scrivere prompt efficaci per Bob Shell per imparare come scrivere prompt che producono in modo affidabile l'output desiderato.