Mode guide
Disponible depuis la 0.2.4
Faites parcourir un flux à un agent dans n’importe quelle application web et Astral rédige le guide utilisateur à votre place.
Ce que vous obtenez
Un guide rédigé à partir d’une exécution enregistrée, dans le dossier de l’exécution à côté de report.html :
guide.mdetguide.html(une page autonome) : un titre, une introduction, une section numérotée par étape et une instruction numérotée pour chaque action.- Une capture d’écran par action, prise avant un clic, avec la cible marquée.
- Une section finale Résultat avec une capture d’écran de clôture.
- Un lien vers l’enregistrement : un MP4 sur macOS, un PNG animé ailleurs.
- Uniquement des noms de fichiers relatifs, de sorte que le dossier peut être déplacé ou compressé tel quel.
Demandez-le à votre agent
Tout agent MCP connecté à Astral peut le faire. Demandez-lui, par exemple : « rédige un guide utilisateur pour créer un client, en espagnol ». Derrière cela se trouve le prompt MCP write-guide, que votre agent liste avec les autres (voir la référence des outils). Ses arguments :
task(obligatoire) : ce qu’enseigne le guide, par exemple « comment créer un compte ».lang: la langue du guide sous forme de code,esouen(enpar défaut).url: le point de départ du parcours (facultatif : sinon, l’onglet courant).
L’agent explore le flux, l’exécute une fois comme exécution de test avec l’option guide, vérifie le résultat et indique les fichiers.
L’option guide
Le prompt utilise une option d’astral.test, que vous pouvez aussi définir vous-même dans un script :
await astral.test('Create a customer', async () => {
await astral.step('Open the customers page', () =>
astral.navigate({url: 'http://127.0.0.1:4555/'}));
// ...the rest of the flow
}, {
record: 'video',
guide: {lang: 'es', title: 'Crear un cliente', intro: 'Cómo dar de alta un cliente nuevo.'}
});guide accepte lang, title et intro. Elle active d’elle-même les captures d’écran par action ; ajoutez record: 'video' pour obtenir aussi un enregistrement. Le résultat de l’exécution contient guide: {md, html, lang}.
Langues
Les légendes dessinées sur la page et les libellés du guide (Résultat, Voir l’enregistrement, Capture d’écran) sont traduits pour l’anglais et l’espagnol. Tout autre code de langue retombe sur des légendes en anglais, tandis que les noms d’étapes, le titre et l’introduction restent dans la langue dans laquelle l’agent les a écrits. Nommez chaque étape comme le ferait l’utilisateur, par exemple « Créez votre compte », et non comme le ferait un test.
Mots de passe
Un mot de passe saisi n’atteint jamais le guide. L’instruction indique « Type your password in «Password» » (ou « Escribe tu contraseña en «Password» » en espagnol) et la valeur n’est écrite dans aucun fichier.
Parcours échoués
Si une étape échoue, le guide est tout de même écrit, mais commence par un avertissement, « This walkthrough did not complete: step N failed. Do not publish this guide as it is. » (dans la langue du guide), et l’étape échouée est marquée. Corrigez le flux et relancez-le.
À quoi cela ressemble
Le guide.md d’une exécution réelle sur l’application de démonstration DevLab (seule l’adresse est remplacée) :
# Cómo crear una cuenta
Esta guía te lleva por el registro paso a paso.
## 1. Abre la página de registro
1. Ve a https://your-app.example/register
## 2. Rellena tus datos
1. Escribe «Ana Guía» en «Name»
2. Escribe «[email protected]» en «Email»
3. Escribe tu contraseña en «Password»
4. Escribe tu contraseña en «Confirm password»
## 3. Crea la cuenta
1. Haz clic en «Create account»
## Resultado
[Ver la grabación](recording.mp4)Les noms de champs proviennent des libellés propres à l’application ; une application en anglais donne donc « Email » au milieu de phrases en espagnol.
Plateformes
Vérifié uniquement sur macOS. L’enregistrement MP4 est encodé sur macOS ; sur les autres systèmes, l’enregistrement est un PNG animé. Windows et Linux ne sont pas vérifiés pour le mode guide.