Premiers pas

Ce guide vous accompagne pas à pas pour installer l’écosystème Gram et compiler votre première recette.

1. Installation

   Installez le CLI gram de manière globale via votre gestionnaire de paquets favori. Il s’exécute aussi bien sur Node.js (>=20) que sur Bun :

   npm

   npm install -D @gram-lang/cli

   bun

   bun add -D @gram-lang/cli

   Note

   Si vous préférez compiler le CLI depuis les sources (par exemple pour contribuer au projet), consultez le fichier CONTRIBUTING.md.

2. Configuration de l’éditeur

   Gram traitant les recettes comme du code, un éditeur bien configuré améliore grandement votre expérience de développement.

   Extension VS Code Gram

   Nous vous recommandons d’installer l’extension Gram pour VS Code. Elle apporte :

   • La coloration syntaxique
   • L’autocomplétion
   • La détection d’erreurs et des diagnostics en temps réel
   • Le rendu du compilateur en direct (Live Preview)

   Cherchez « Gram - Recipe Language » dans le panneau des extensions (Ctrl+Shift+X / Cmd+Shift+X) et installez-la, ou téléchargez-la directement sur le VS Code Marketplace.

   Compiler depuis les sources

   git clone https://git.gram-lang.org/gram-lang/gram.git
   cd gram
   bun install
   
   # Packager l'extension (cela génère un fichier .vsix)
   cd packages/vscode-extension
   bun run package
   
   # Installer le paquet dans VS Code
   code --install-extension gram-lang-*.vsix

3. Initialiser un projet

   Avant de rédiger votre première recette, nous vous conseillons d’initialiser un espace de travail (workspace) Gram. Dans un nouveau dossier, exécutez :

   gram init

   Cette commande génère un répertoire .gram/ contenant votre configuration et une base de données initiale.

   Configuration interactive

   Le CLI vous posera quelques questions pour configurer votre fournisseur d’IA (utile ultérieurement pour extraire ou importer des recettes). Cette étape n’est pas nécessaire pour votre première recette : vous pouvez simplement appuyer sur Entrée pour ignorer ces questions et conserver les options par défaut.

4. Écrire une recette simple

   Créons maintenant une recette de pancakes.

   Créez un fichier pancakes.gram, ouvrez-le dans votre éditeur et copiez-y la recette suivante :

   pancakes.gram

   ---
   title: Pancakes
   portions: 2
   ---
   
   ## Appareil ->&appareil
   
   Dans un #bol moyen{}, mélanger la @farine{160 g}, la @levure chimique{1 c.à.c}, le @sucre{1 c.à.s} et le @sel{1/4 c.à.c}. ->&mélange sec{}
   
   Au &mélange sec{}, ajouter le @lait ribot{1 tasse}, l'@œuf{1} et l'@extrait de vanille{1/2 c.à.c}.
   
   ## Cuisson
   
   Verser l'&appareil sur une #plaque de cuisson{} à ^{feu moyen} et cuire pendant ~{2 min}.

5. Compiler la recette

   Il est temps d’observer le compilateur à l’œuvre !

   Dans votre terminal, exécutez la commande suivante pour compiler la recette en un fichier JSON structuré :

   gram build pancakes.gram

   Cette commande analyse la recette et génère sa représentation JSON. Par défaut, le résultat s’affiche directement dans la console, mais vous pouvez également l’enregistrer dans un fichier :

   gram build pancakes.gram -o pancakes.json

   Si le format JSON est idéal pour intégrer Gram à vos applications, il reste peu adapté à une lecture directe par un utilisateur.

   Pour un affichage structuré et lisible directement dans votre terminal, utilisez la commande view :

   gram view pancakes.gram

   Essayez le playground

   Si vous ne souhaitez rien installer pour le moment, vous pouvez tester Gram directement dans votre navigateur grâce au Playground (ou visualiser la recette via l’extension VS Code).

Prochaines étapes

Maintenant que vous maîtrisez les bases, découvrez les fonctionnalités avancées de Gram : variables, minuteurs passifs et ajustement automatique des portions.

Tutoriel : votre première recette complexeApprenez à utiliser les variables intermédiaires, les minuteurs passifs et les ingrédients composites.

Structure du documentDécouvrez comment est organisé un fichier Gram.