Loading LISEZMOI.md +1 −1 Changes for LISEZMOI.md: 1 added line, 1 removed line. Original line number Diff line number Diff line Loading @@ -14,7 +14,7 @@ Ce dossier contient l'implémentation de `climax`, la CLI utilisée pour gérer - exporter une copie statique du site (`freeze`) - inspecter les ressources de bundles (`templates-list`, `static-list`) Voir [`commands.md`](./commands.md) pour la référence complète des commandes avec exemples. Voir [`commandes.md`](./commandes.md) pour la référence complète des commandes avec exemples. ## Périmètre et notes Loading commandes.md 0 → 100644 +334 −0 Changes for commandes.md: 334 added lines, 0 removed lines. Original line number Diff line number Diff line # Référence des commandes climax `climax` gère les projets MaX et le runtime BaseX embarqué utilisé par MaX. La plupart des commandes sont prévues pour être lancées depuis le dossier d'un projet MaX. Les commandes qui acceptent `--directory` peuvent cibler un projet explicitement. Options globales : - `--lang fr|en` : choisit la langue de sortie. Cette option est prioritaire sur `CLIMAX_LANG` et `LANG`. - `--help` : affiche l'aide climax pour les commandes ordinaires. ## new Crée un nouveau projet MaX, ou initialise le dossier courant. ```sh climax new climax new /path/to/project climax new /path/to/project --interactive ``` Options : - `--interactive` : choisit les valeurs du projet via des prompts. ## demo Installe l'édition de demonstration dans un projet MaX existant. ```sh climax demo climax demo --directory /path/to/project ``` Options : - `--directory <path>` : dossier du projet MaX. ## start Démarre la stack HTTP/BaseX de MaX. ```sh climax start climax start --http-port 8088 --http-stop-port 8089 climax start --http-host 127.0.0.1 --basex-port 1984 climax start --service ``` Options : - `--directory <path>` : dossier du projet MaX. - `--http-host <host>` : hôte d'écoute HTTP. - `--http-port <port>` : port HTTP. - `--basex-port <port>` : port BaseX. - `--http-stop-port <port>` : port d'arrêt. - `--service` : démarre MaX comme processus de service. ## stop Arrête une instance MaX en cours d'exécution. ```sh climax stop climax stop --http-stop-port 8089 climax stop --directory /path/to/project ``` Options : - `--directory <path>` : dossier du projet MaX. - `--http-stop-port <port>` : port d'arrêt. ## info Affiche la configuration du projet MaX. La sortie par défaut est un tableau stylisé. ```sh climax info climax info --directory /path/to/project climax info --json-out ``` Options : - `--directory <path>` : dossier du projet MaX. - `--json-out` : produit du JSON au lieu du tableau stylise. ## freeze Crée une copie HTML statique d'un site MaX. ```sh climax freeze --output ./site climax freeze --directory /path/to/project --output /tmp/site climax freeze --output ./site --debug ``` Options : - `--directory <path>` : dossier du projet MaX. - `--output <path>` : dossier de sortie pour les fichiers HTML/statiques. - `--debug` : active la sortie de debug. ## bundles-list Liste les bundles disponibles et configurés. ```sh climax bundles-list climax bundles-list --directory /path/to/project ``` Options : - `--directory <path>` : dossier du projet MaX. ## bundles-add Ajoute un bundle à la configuration du projet, puis synchronise le projet. ```sh climax bundles-add max-dev climax bundles-add max-dev --directory /path/to/project climax bundles-add ./local-bundle.zip ``` Options : - `--directory <path>` : dossier du projet MaX. ## bundles-remove Supprime un bundle de la configuration du projet, puis synchronise le projet. ```sh climax bundles-remove max-dev climax bundles-remove max-dev --directory /path/to/project ``` Options : - `--directory <path>` : dossier du projet MaX. ## feed Charge un fichier XML ou un dossier dans la base BaseX `max`. ```sh climax feed ./document.xml climax feed ./xml-directory --yes climax feed ./document.xml --directory /path/to/project --verbose ``` Quand le chemin est un fichier standard, climax l'enregistre dans la base `max` sous le nom de base du fichier. Par exemple, `./data/chapter1.xml` est stocké sous `chapter1.xml`. Si une ressource du même nom existe déja dans BaseX, climax demande une confirmation avant de la remplacer. `--yes` passe cette confirmation. Quand le chemin est un dossier, climax charge le contenu du dossier à la racine de la base `max`. Les imports de dossiers sont traités comme un remplacement du contenu de la base, donc climax demande une confirmation avant d'executer la commande sauf si `--yes` est fourni. Le chemin du dossier est transmis à BaseX avec un séparateur final afin que BaseX charge le contenu du dossier plutôt que de stocker le dossier lui-même sous son nom. Si la base `max` n'existe pas encore, climax la crée avant d'importer le fichier ou le dossier. En cas de succès, la commande affiche le chemin absolu du fichier ou du dossier importé. Options : - `--directory <path>` : dossier du projet MaX. - `--verbose` : affiche la commande BaseX executée. - `--yes`, `-y` : supprime les confirmations de remplacement. ## sync Installe ou rafraichit `.max`, BaseX, les fichiers MaX, les ressources et les bundles configures. ```sh climax sync climax sync --directory /path/to/project ``` Options : - `--directory <path>` : dossier du projet MaX. ## run Execute un script XQuery d'un bundle actif. Le format de cible est `<bundle>/<script>`. Le script est résolu sous : ```text .max/basex/webapp/max/bundles/<bundle>/scripts/<script>.xq ``` Le bundle doit être actif : son dossier doit exister et ne doit pas contenir de fichier `.ignore`. Les arguments placés après la cible sont convertis en bindings de variables externes BaseX. ```sh climax run max-dev/helloworld climax run max-dev/helloworld -name Alice -count 3 climax run max-dev/helloworld --dry-run climax run --directory /path/to/project max-dev/helloworld -name Alice ``` Exemples de conversion des arguments : ```text -name Alice -> -b name=Alice -count=3 -> -b count=3 --dry-run -> -b dry-run=true ``` Exemple de script : ```xquery declare variable $name external := "world"; declare variable $count external := "1"; for $i in 1 to xs:integer($count) return concat("Hello ", $name, "!") ``` Options : - `--directory <path>` : dossier du projet MaX. Cette option doit apparaitre avant la cible `<bundle>/<script>`. ## basex Lance la classe shell BaseX (`org.basex.BaseX`) pour le projet courant. Contrairement aux commandes climax ordinaires, cette commande transmet les options inconnues a BaseX. `--help` est aussi transmis a BaseX ; utilisez `climax help basex` pour afficher l'aide locale de climax. ```sh climax basex climax basex --directory /path/to/project climax basex -h climax basex -q "1 + 1" climax basex -s method=json -q "map { 'ok': true() }" ``` Options gérées par climax : - `--directory <path>` : dossier du projet MaX. - `--verbose` : affiche la commande Java/BaseX executee. Tous les autres arguments sont transmis à BaseX exactement comme ils sont écrits. Climax ne traduit pas les options longues de style GNU en options BaseX ; utilisez donc les noms d'options BaseX, comme `-h`, `-q`, `-Q`, `-b` et `-s`. ## basex-gui Lance la classe GUI BaseX (`org.basex.BaseXGUI`) pour le projet courant. ```sh climax basex-gui climax basex-gui --directory /path/to/project climax basex-gui --verbose ``` Options : - `--directory <path>` : dossier du projet MaX. - `--verbose` : affiche la commande Java/BaseX exécutée. ## templates-list Liste les fichiers de templates du bundle de vocabulaire configure. La sortie est une liste simple de chemins, une ligne par chemin. ```sh climax templates-list climax templates-list --directory /path/to/project ``` Options : - `--directory <path>` : dossier du projet MaX. ## static-list Liste les fichiers statiques du bundle de vocabulaire configure. La sortie est une liste simple de chemins, une ligne par chemin. ```sh climax static-list climax static-list --directory /path/to/project ``` Options : - `--directory <path>` : dossier du projet MaX. ## projects Liste les projets connus de climax. La sortie par défaut est un tableau stylisé. ```sh climax projects climax projects --json-out ``` Options : - `--json-out` : produit du JSON au lieu du tableau stylisé. ## cache-clear Vide le cache des artefacts téléchargés pour MaX/BaseX. ```sh climax cache-clear ``` ## version Affiche la version de climax. ```sh climax version ``` Loading
LISEZMOI.md +1 −1 Changes for LISEZMOI.md: 1 added line, 1 removed line. Original line number Diff line number Diff line Loading @@ -14,7 +14,7 @@ Ce dossier contient l'implémentation de `climax`, la CLI utilisée pour gérer - exporter une copie statique du site (`freeze`) - inspecter les ressources de bundles (`templates-list`, `static-list`) Voir [`commands.md`](./commands.md) pour la référence complète des commandes avec exemples. Voir [`commandes.md`](./commandes.md) pour la référence complète des commandes avec exemples. ## Périmètre et notes Loading
commandes.md 0 → 100644 +334 −0 Changes for commandes.md: 334 added lines, 0 removed lines. Original line number Diff line number Diff line # Référence des commandes climax `climax` gère les projets MaX et le runtime BaseX embarqué utilisé par MaX. La plupart des commandes sont prévues pour être lancées depuis le dossier d'un projet MaX. Les commandes qui acceptent `--directory` peuvent cibler un projet explicitement. Options globales : - `--lang fr|en` : choisit la langue de sortie. Cette option est prioritaire sur `CLIMAX_LANG` et `LANG`. - `--help` : affiche l'aide climax pour les commandes ordinaires. ## new Crée un nouveau projet MaX, ou initialise le dossier courant. ```sh climax new climax new /path/to/project climax new /path/to/project --interactive ``` Options : - `--interactive` : choisit les valeurs du projet via des prompts. ## demo Installe l'édition de demonstration dans un projet MaX existant. ```sh climax demo climax demo --directory /path/to/project ``` Options : - `--directory <path>` : dossier du projet MaX. ## start Démarre la stack HTTP/BaseX de MaX. ```sh climax start climax start --http-port 8088 --http-stop-port 8089 climax start --http-host 127.0.0.1 --basex-port 1984 climax start --service ``` Options : - `--directory <path>` : dossier du projet MaX. - `--http-host <host>` : hôte d'écoute HTTP. - `--http-port <port>` : port HTTP. - `--basex-port <port>` : port BaseX. - `--http-stop-port <port>` : port d'arrêt. - `--service` : démarre MaX comme processus de service. ## stop Arrête une instance MaX en cours d'exécution. ```sh climax stop climax stop --http-stop-port 8089 climax stop --directory /path/to/project ``` Options : - `--directory <path>` : dossier du projet MaX. - `--http-stop-port <port>` : port d'arrêt. ## info Affiche la configuration du projet MaX. La sortie par défaut est un tableau stylisé. ```sh climax info climax info --directory /path/to/project climax info --json-out ``` Options : - `--directory <path>` : dossier du projet MaX. - `--json-out` : produit du JSON au lieu du tableau stylise. ## freeze Crée une copie HTML statique d'un site MaX. ```sh climax freeze --output ./site climax freeze --directory /path/to/project --output /tmp/site climax freeze --output ./site --debug ``` Options : - `--directory <path>` : dossier du projet MaX. - `--output <path>` : dossier de sortie pour les fichiers HTML/statiques. - `--debug` : active la sortie de debug. ## bundles-list Liste les bundles disponibles et configurés. ```sh climax bundles-list climax bundles-list --directory /path/to/project ``` Options : - `--directory <path>` : dossier du projet MaX. ## bundles-add Ajoute un bundle à la configuration du projet, puis synchronise le projet. ```sh climax bundles-add max-dev climax bundles-add max-dev --directory /path/to/project climax bundles-add ./local-bundle.zip ``` Options : - `--directory <path>` : dossier du projet MaX. ## bundles-remove Supprime un bundle de la configuration du projet, puis synchronise le projet. ```sh climax bundles-remove max-dev climax bundles-remove max-dev --directory /path/to/project ``` Options : - `--directory <path>` : dossier du projet MaX. ## feed Charge un fichier XML ou un dossier dans la base BaseX `max`. ```sh climax feed ./document.xml climax feed ./xml-directory --yes climax feed ./document.xml --directory /path/to/project --verbose ``` Quand le chemin est un fichier standard, climax l'enregistre dans la base `max` sous le nom de base du fichier. Par exemple, `./data/chapter1.xml` est stocké sous `chapter1.xml`. Si une ressource du même nom existe déja dans BaseX, climax demande une confirmation avant de la remplacer. `--yes` passe cette confirmation. Quand le chemin est un dossier, climax charge le contenu du dossier à la racine de la base `max`. Les imports de dossiers sont traités comme un remplacement du contenu de la base, donc climax demande une confirmation avant d'executer la commande sauf si `--yes` est fourni. Le chemin du dossier est transmis à BaseX avec un séparateur final afin que BaseX charge le contenu du dossier plutôt que de stocker le dossier lui-même sous son nom. Si la base `max` n'existe pas encore, climax la crée avant d'importer le fichier ou le dossier. En cas de succès, la commande affiche le chemin absolu du fichier ou du dossier importé. Options : - `--directory <path>` : dossier du projet MaX. - `--verbose` : affiche la commande BaseX executée. - `--yes`, `-y` : supprime les confirmations de remplacement. ## sync Installe ou rafraichit `.max`, BaseX, les fichiers MaX, les ressources et les bundles configures. ```sh climax sync climax sync --directory /path/to/project ``` Options : - `--directory <path>` : dossier du projet MaX. ## run Execute un script XQuery d'un bundle actif. Le format de cible est `<bundle>/<script>`. Le script est résolu sous : ```text .max/basex/webapp/max/bundles/<bundle>/scripts/<script>.xq ``` Le bundle doit être actif : son dossier doit exister et ne doit pas contenir de fichier `.ignore`. Les arguments placés après la cible sont convertis en bindings de variables externes BaseX. ```sh climax run max-dev/helloworld climax run max-dev/helloworld -name Alice -count 3 climax run max-dev/helloworld --dry-run climax run --directory /path/to/project max-dev/helloworld -name Alice ``` Exemples de conversion des arguments : ```text -name Alice -> -b name=Alice -count=3 -> -b count=3 --dry-run -> -b dry-run=true ``` Exemple de script : ```xquery declare variable $name external := "world"; declare variable $count external := "1"; for $i in 1 to xs:integer($count) return concat("Hello ", $name, "!") ``` Options : - `--directory <path>` : dossier du projet MaX. Cette option doit apparaitre avant la cible `<bundle>/<script>`. ## basex Lance la classe shell BaseX (`org.basex.BaseX`) pour le projet courant. Contrairement aux commandes climax ordinaires, cette commande transmet les options inconnues a BaseX. `--help` est aussi transmis a BaseX ; utilisez `climax help basex` pour afficher l'aide locale de climax. ```sh climax basex climax basex --directory /path/to/project climax basex -h climax basex -q "1 + 1" climax basex -s method=json -q "map { 'ok': true() }" ``` Options gérées par climax : - `--directory <path>` : dossier du projet MaX. - `--verbose` : affiche la commande Java/BaseX executee. Tous les autres arguments sont transmis à BaseX exactement comme ils sont écrits. Climax ne traduit pas les options longues de style GNU en options BaseX ; utilisez donc les noms d'options BaseX, comme `-h`, `-q`, `-Q`, `-b` et `-s`. ## basex-gui Lance la classe GUI BaseX (`org.basex.BaseXGUI`) pour le projet courant. ```sh climax basex-gui climax basex-gui --directory /path/to/project climax basex-gui --verbose ``` Options : - `--directory <path>` : dossier du projet MaX. - `--verbose` : affiche la commande Java/BaseX exécutée. ## templates-list Liste les fichiers de templates du bundle de vocabulaire configure. La sortie est une liste simple de chemins, une ligne par chemin. ```sh climax templates-list climax templates-list --directory /path/to/project ``` Options : - `--directory <path>` : dossier du projet MaX. ## static-list Liste les fichiers statiques du bundle de vocabulaire configure. La sortie est une liste simple de chemins, une ligne par chemin. ```sh climax static-list climax static-list --directory /path/to/project ``` Options : - `--directory <path>` : dossier du projet MaX. ## projects Liste les projets connus de climax. La sortie par défaut est un tableau stylisé. ```sh climax projects climax projects --json-out ``` Options : - `--json-out` : produit du JSON au lieu du tableau stylisé. ## cache-clear Vide le cache des artefacts téléchargés pour MaX/BaseX. ```sh climax cache-clear ``` ## version Affiche la version de climax. ```sh climax version ```
