Loading commandes.md +208 −13 Changes for commandes.md: 208 added lines, 13 removed lines. Original line number Diff line number Diff line Loading @@ -15,9 +15,21 @@ Options globales : Crée un nouveau projet MaX, ou initialise le dossier courant. - Initialise le dossier courant comme projet MaX : ```sh climax new ``` - Crée un projet MaX à un chemin précis : ```sh climax new /path/to/project ``` - Crée un projet et choisit ses valeurs via des prompts : ```sh climax new /path/to/project --interactive ``` Loading @@ -27,10 +39,17 @@ Options : ## demo Installe l'édition de demonstration dans un projet MaX existant. Installe l'édition de démonstration dans un projet MaX existant. - Installe l'édition de démonstration dans le projet courant : ```sh climax demo ``` - Installe l'édition de démonstration dans un projet choisi par chemin : ```sh climax demo --directory /path/to/project ``` Loading @@ -42,10 +61,27 @@ Options : Démarre la stack HTTP/BaseX de MaX. - Démarre le projet courant avec les ports configurés : ```sh climax start ``` - Démarre avec des ports HTTP et d'arrêt explicites : ```sh climax start --http-port 8088 --http-stop-port 8089 ``` - Lie HTTP à un hôte précis et utilise un port BaseX précis : ```sh climax start --http-host 127.0.0.1 --basex-port 1984 ``` - Démarre MaX comme processus de service : ```sh climax start --service ``` Loading @@ -62,9 +98,21 @@ Options : Arrête une instance MaX en cours d'exécution. - Arrête l'instance MaX en cours d'exécution pour le projet courant : ```sh climax stop ``` - Arrête une instance en utilisant un port d'arrêt explicite : ```sh climax stop --http-stop-port 8089 ``` - Arrête l'instance d'un projet choisi par chemin : ```sh climax stop --directory /path/to/project ``` Loading @@ -78,16 +126,28 @@ Options : Affiche la configuration du projet MaX. La sortie par défaut est un tableau stylisé. - Affiche la configuration du projet courant sous forme de tableau stylisé : ```sh climax info ``` - Affiche la configuration d'un projet choisi par chemin : ```sh climax info --directory /path/to/project ``` - Produit la configuration du projet courant en JSON : ```sh climax info --json-out ``` Options : - `--directory <path>` : dossier du projet MaX. - `--json-out` : produit du JSON au lieu du tableau stylise. - `--json-out` : produit du JSON au lieu du tableau stylisé. ## freeze Loading @@ -101,9 +161,21 @@ configuré depuis `.max/basex/webapp/max/bundles/<bundle>/static` vers `<output>/<bundle>/static`. Les fichiers déjà écrits pendant le parcours sont conservés. - Gèle le projet courant dans `./site` : ```sh climax freeze --output ./site ``` - Gèle un projet choisi par chemin dans `/tmp/site` : ```sh climax freeze --directory /path/to/project --output /tmp/site ``` - Conserve la sortie de debug pendant le gel : ```sh climax freeze --output ./site --debug ``` Loading @@ -116,9 +188,18 @@ Options : ## bundles-list Liste les bundles disponibles et configurés. Un bundle est un paquet d'extension MaX qui peut ajouter des templates, des fichiers statiques, des scripts ou d'autres ressources au projet. - Liste les bundles du projet courant : ```sh climax bundles-list ``` - Liste les bundles d'un projet choisi par chemin : ```sh climax bundles-list --directory /path/to/project ``` Loading @@ -130,9 +211,21 @@ Options : Ajoute un bundle à la configuration du projet, puis synchronise le projet. - Ajoute le bundle `max-dev` au projet courant : ```sh climax bundles-add max-dev ``` - Ajoute le bundle `max-dev` à un projet choisi par chemin : ```sh climax bundles-add max-dev --directory /path/to/project ``` - Ajoute une archive de bundle locale au projet courant : ```sh climax bundles-add ./local-bundle.zip ``` Loading @@ -144,8 +237,15 @@ Options : Supprime un bundle de la configuration du projet, puis synchronise le projet. - Supprime le bundle `max-dev` du projet courant : ```sh climax bundles-remove max-dev ``` - Supprime le bundle `max-dev` d'un projet choisi par chemin : ```sh climax bundles-remove max-dev --directory /path/to/project ``` Loading @@ -157,21 +257,33 @@ Options : Charge un fichier XML ou un dossier dans la base BaseX `max`. - Charge un fichier XML dans la base `max` du projet courant : ```sh climax feed ./document.xml ``` - Charge un dossier dans la base `max` et passe les confirmations : ```sh climax feed ./xml-directory --yes ``` - Charge un fichier XML pour un projet choisi par chemin et affiche la commande BaseX : ```sh 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 stocké sous `chapter1.xml`. Si une ressource du même nom existe déjà 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 du contenu de la base, donc climax demande une confirmation avant d'exécuter 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. Loading @@ -183,16 +295,23 @@ du fichier ou du dossier importé. Options : - `--directory <path>` : dossier du projet MaX. - `--verbose` : affiche la commande BaseX executée. - `--verbose` : affiche la commande BaseX exécutée. - `--yes`, `-y` : supprime les confirmations de remplacement. ## sync Installe ou rafraichit `.max`, BaseX, les fichiers MaX, les ressources et les bundles configures. Installe ou rafraîchit `.max`, BaseX, les fichiers MaX, les ressources et les bundles configurés. - Synchronise le projet courant : ```sh climax sync ``` - Synchronise un projet choisi par chemin : ```sh climax sync --directory /path/to/project ``` Loading @@ -202,7 +321,7 @@ Options : ## run Execute un script XQuery d'un bundle actif. Le format de cible est Exécute un script XQuery d'un bundle actif. Le format de cible est `<bundle>/<script>`. Le script est résolu sous : ```text Loading @@ -213,10 +332,27 @@ 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. - Exécute le script `helloworld` du bundle actif `max-dev` : ```sh climax run max-dev/helloworld ``` - Exécute un script avec des bindings de variables externes : ```sh climax run max-dev/helloworld -name Alice -count 3 ``` - Passe un binding de variable externe booléen : ```sh climax run max-dev/helloworld --dry-run ``` - Exécute un script de bundle pour un projet choisi par chemin : ```sh climax run --directory /path/to/project max-dev/helloworld -name Alice ``` Loading @@ -240,28 +376,50 @@ return concat("Hello ", $name, "!") Options : - `--directory <path>` : dossier du projet MaX. Cette option doit apparaitre - `--directory <path>` : dossier du projet MaX. Cette option doit apparaître 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 options inconnues à BaseX. `--help` est aussi transmis à BaseX ; utilisez `climax help basex` pour afficher l'aide locale de climax. - Ouvre le shell BaseX pour le projet courant : ```sh climax basex ``` - Ouvre le shell BaseX pour un projet choisi par chemin : ```sh climax basex --directory /path/to/project ``` - Affiche l'aide propre à BaseX : ```sh climax basex -h ``` - Exécute une requête BaseX : ```sh climax basex -q "1 + 1" ``` - Exécute une requête BaseX avec une option de sérialisation : ```sh 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. - `--verbose` : affiche la commande Java/BaseX exécutée. Tous les autres arguments sont transmis à BaseX exactement comme ils sont écrits. Climax ne traduit pas les options longues de style GNU en options Loading @@ -272,9 +430,21 @@ et `-s`. Lance la classe GUI BaseX (`org.basex.BaseXGUI`) pour le projet courant. - Lance l'interface graphique BaseX pour le projet courant : ```sh climax basex-gui ``` - Lance l'interface graphique BaseX pour un projet choisi par chemin : ```sh climax basex-gui --directory /path/to/project ``` - Affiche la commande Java/BaseX avant de lancer l'interface graphique : ```sh climax basex-gui --verbose ``` Loading @@ -285,11 +455,18 @@ Options : ## templates-list Liste les fichiers de templates du bundle de vocabulaire configure. La sortie Liste les fichiers de templates du bundle de vocabulaire configuré. La sortie est une liste simple de chemins, une ligne par chemin. - Liste les fichiers de templates du projet courant : ```sh climax templates-list ``` - Liste les fichiers de templates d'un projet choisi par chemin : ```sh climax templates-list --directory /path/to/project ``` Loading @@ -299,11 +476,18 @@ Options : ## static-list Liste les fichiers statiques du bundle de vocabulaire configure. La sortie est Liste les fichiers statiques du bundle de vocabulaire configuré. La sortie est une liste simple de chemins, une ligne par chemin. - Liste les fichiers statiques du projet courant : ```sh climax static-list ``` - Liste les fichiers statiques d'un projet choisi par chemin : ```sh climax static-list --directory /path/to/project ``` Loading @@ -316,8 +500,15 @@ Options : Liste les projets connus de climax. La sortie par défaut est un tableau stylisé. - Liste les projets connus sous forme de tableau stylisé : ```sh climax projects ``` - Produit les projets connus en JSON : ```sh climax projects --json-out ``` Loading @@ -329,6 +520,8 @@ Options : Vide le cache des artefacts téléchargés pour MaX/BaseX. - Vide le cache des téléchargements utilisés par climax : ```sh climax cache-clear ``` Loading @@ -337,6 +530,8 @@ climax cache-clear Affiche la version de climax. - Affiche la version installée de climax : ```sh climax version ``` commands.md +195 −0 Changes for commands.md: 195 added lines, 0 removed lines. Original line number Diff line number Diff line Loading @@ -14,9 +14,21 @@ Global options: Create a new MaX project, or initialize the current directory. - Initialize the current directory as a MaX project: ```sh climax new ``` - Create a MaX project at a specific path: ```sh climax new /path/to/project ``` - Create a project and choose project values from prompts: ```sh climax new /path/to/project --interactive ``` Loading @@ -28,8 +40,15 @@ Options: Install the demo edition into an existing MaX project. - Install the demo edition in the current project: ```sh climax demo ``` - Install the demo edition in a project selected by path: ```sh climax demo --directory /path/to/project ``` Loading @@ -41,10 +60,27 @@ Options: Start the MaX HTTP/BaseX stack. - Start the current project with the configured ports: ```sh climax start ``` - Start with explicit HTTP and stop ports: ```sh climax start --http-port 8088 --http-stop-port 8089 ``` - Bind HTTP to a specific host and use a specific BaseX port: ```sh climax start --http-host 127.0.0.1 --basex-port 1984 ``` - Start MaX as a service process: ```sh climax start --service ``` Loading @@ -61,9 +97,21 @@ Options: Stop a running MaX instance. - Stop the current project's running MaX instance: ```sh climax stop ``` - Stop an instance by using an explicit stop port: ```sh climax stop --http-stop-port 8089 ``` - Stop the instance for a project selected by path: ```sh climax stop --directory /path/to/project ``` Loading @@ -76,9 +124,21 @@ Options: Show MaX project configuration. The default output is a styled table. - Show the current project's configuration as a styled table: ```sh climax info ``` - Show configuration for a project selected by path: ```sh climax info --directory /path/to/project ``` - Emit the current project's configuration as JSON: ```sh climax info --json-out ``` Loading @@ -97,9 +157,21 @@ After the crawl, `freeze` also copies the `static` directory of every configured bundle from `.max/basex/webapp/max/bundles/<bundle>/static` to `<output>/<bundle>/static`. Files already written during the crawl are kept. - Freeze the current project into `./site`: ```sh climax freeze --output ./site ``` - Freeze a project selected by path into `/tmp/site`: ```sh climax freeze --directory /path/to/project --output /tmp/site ``` - Keep debug output enabled while freezing: ```sh climax freeze --output ./site --debug ``` Loading @@ -112,9 +184,18 @@ Options: ## bundles-list List available and configured bundles. Output keeps the existing table style. A bundle is a MaX extension package that can add templates, static assets, scripts, or other project resources. - List bundles for the current project: ```sh climax bundles-list ``` - List bundles for a project selected by path: ```sh climax bundles-list --directory /path/to/project ``` Loading @@ -126,9 +207,21 @@ Options: Add a bundle to the project configuration, then sync the project. - Add the `max-dev` bundle to the current project: ```sh climax bundles-add max-dev ``` - Add the `max-dev` bundle to a project selected by path: ```sh climax bundles-add max-dev --directory /path/to/project ``` - Add a local bundle archive to the current project: ```sh climax bundles-add ./local-bundle.zip ``` Loading @@ -140,8 +233,15 @@ Options: Remove a bundle from the project configuration, then sync the project. - Remove the `max-dev` bundle from the current project: ```sh climax bundles-remove max-dev ``` - Remove the `max-dev` bundle from a project selected by path: ```sh climax bundles-remove max-dev --directory /path/to/project ``` Loading @@ -153,9 +253,21 @@ Options: Load an XML file or directory into the BaseX `max` database. - Load one XML file into the current project's `max` database: ```sh climax feed ./document.xml ``` - Load a directory into the `max` database and skip confirmation prompts: ```sh climax feed ./xml-directory --yes ``` - Load one XML file for a project selected by path and print the BaseX command: ```sh climax feed ./document.xml --directory /path/to/project --verbose ``` Loading Loading @@ -186,8 +298,15 @@ Options: Install or refresh `.max`, BaseX, MaX files, resources, and configured bundles. - Sync the current project: ```sh climax sync ``` - Sync a project selected by path: ```sh climax sync --directory /path/to/project ``` Loading @@ -208,10 +327,27 @@ The bundle must be active: its bundle directory must exist and must not contain a `.ignore` file. Script arguments after the target are converted to BaseX external variable bindings. - Run the `helloworld` script from the active `max-dev` bundle: ```sh climax run max-dev/helloworld ``` - Run a script with external variable bindings: ```sh climax run max-dev/helloworld -name Alice -count 3 ``` - Pass a boolean external variable binding: ```sh climax run max-dev/helloworld --dry-run ``` - Run a bundle script for a project selected by path: ```sh climax run --directory /path/to/project max-dev/helloworld -name Alice ``` Loading Loading @@ -245,11 +381,33 @@ Unlike normal climax commands, this command forwards unknown flags to BaseX. `--help` is also forwarded to BaseX; use `climax help basex` for local climax help. - Open the BaseX shell for the current project: ```sh climax basex ``` - Open the BaseX shell for a project selected by path: ```sh climax basex --directory /path/to/project ``` - Show BaseX's own help: ```sh climax basex -h ``` - Run a BaseX query: ```sh climax basex -q "1 + 1" ``` - Run a BaseX query with a serialization option: ```sh climax basex -s method=json -q "map { 'ok': true() }" ``` Loading @@ -266,9 +424,21 @@ names, such as `-h`, `-q`, `-Q`, `-b`, and `-s`. Launch the BaseX GUI class (`org.basex.BaseXGUI`) for the current project. - Launch the BaseX GUI for the current project: ```sh climax basex-gui ``` - Launch the BaseX GUI for a project selected by path: ```sh climax basex-gui --directory /path/to/project ``` - Print the Java/BaseX command before launching the GUI: ```sh climax basex-gui --verbose ``` Loading @@ -282,8 +452,15 @@ Options: List template files from the configured vocabulary bundle. Output is plain line-by-line paths. - List template files for the current project: ```sh climax templates-list ``` - List template files for a project selected by path: ```sh climax templates-list --directory /path/to/project ``` Loading @@ -296,8 +473,15 @@ Options: List static files from the configured vocabulary bundle. Output is plain line-by-line paths. - List static files for the current project: ```sh climax static-list ``` - List static files for a project selected by path: ```sh climax static-list --directory /path/to/project ``` Loading @@ -309,8 +493,15 @@ Options: List projects known to climax. The default output is a styled table. - List known projects as a styled table: ```sh climax projects ``` - Emit known projects as JSON: ```sh climax projects --json-out ``` Loading @@ -322,6 +513,8 @@ Options: Clear cached MaX/BaseX download artifacts. - Clear cached downloads used by climax: ```sh climax cache-clear ``` Loading @@ -330,6 +523,8 @@ climax cache-clear Print the climax version. - Print the installed climax version: ```sh climax version ``` Loading
commandes.md +208 −13 Changes for commandes.md: 208 added lines, 13 removed lines. Original line number Diff line number Diff line Loading @@ -15,9 +15,21 @@ Options globales : Crée un nouveau projet MaX, ou initialise le dossier courant. - Initialise le dossier courant comme projet MaX : ```sh climax new ``` - Crée un projet MaX à un chemin précis : ```sh climax new /path/to/project ``` - Crée un projet et choisit ses valeurs via des prompts : ```sh climax new /path/to/project --interactive ``` Loading @@ -27,10 +39,17 @@ Options : ## demo Installe l'édition de demonstration dans un projet MaX existant. Installe l'édition de démonstration dans un projet MaX existant. - Installe l'édition de démonstration dans le projet courant : ```sh climax demo ``` - Installe l'édition de démonstration dans un projet choisi par chemin : ```sh climax demo --directory /path/to/project ``` Loading @@ -42,10 +61,27 @@ Options : Démarre la stack HTTP/BaseX de MaX. - Démarre le projet courant avec les ports configurés : ```sh climax start ``` - Démarre avec des ports HTTP et d'arrêt explicites : ```sh climax start --http-port 8088 --http-stop-port 8089 ``` - Lie HTTP à un hôte précis et utilise un port BaseX précis : ```sh climax start --http-host 127.0.0.1 --basex-port 1984 ``` - Démarre MaX comme processus de service : ```sh climax start --service ``` Loading @@ -62,9 +98,21 @@ Options : Arrête une instance MaX en cours d'exécution. - Arrête l'instance MaX en cours d'exécution pour le projet courant : ```sh climax stop ``` - Arrête une instance en utilisant un port d'arrêt explicite : ```sh climax stop --http-stop-port 8089 ``` - Arrête l'instance d'un projet choisi par chemin : ```sh climax stop --directory /path/to/project ``` Loading @@ -78,16 +126,28 @@ Options : Affiche la configuration du projet MaX. La sortie par défaut est un tableau stylisé. - Affiche la configuration du projet courant sous forme de tableau stylisé : ```sh climax info ``` - Affiche la configuration d'un projet choisi par chemin : ```sh climax info --directory /path/to/project ``` - Produit la configuration du projet courant en JSON : ```sh climax info --json-out ``` Options : - `--directory <path>` : dossier du projet MaX. - `--json-out` : produit du JSON au lieu du tableau stylise. - `--json-out` : produit du JSON au lieu du tableau stylisé. ## freeze Loading @@ -101,9 +161,21 @@ configuré depuis `.max/basex/webapp/max/bundles/<bundle>/static` vers `<output>/<bundle>/static`. Les fichiers déjà écrits pendant le parcours sont conservés. - Gèle le projet courant dans `./site` : ```sh climax freeze --output ./site ``` - Gèle un projet choisi par chemin dans `/tmp/site` : ```sh climax freeze --directory /path/to/project --output /tmp/site ``` - Conserve la sortie de debug pendant le gel : ```sh climax freeze --output ./site --debug ``` Loading @@ -116,9 +188,18 @@ Options : ## bundles-list Liste les bundles disponibles et configurés. Un bundle est un paquet d'extension MaX qui peut ajouter des templates, des fichiers statiques, des scripts ou d'autres ressources au projet. - Liste les bundles du projet courant : ```sh climax bundles-list ``` - Liste les bundles d'un projet choisi par chemin : ```sh climax bundles-list --directory /path/to/project ``` Loading @@ -130,9 +211,21 @@ Options : Ajoute un bundle à la configuration du projet, puis synchronise le projet. - Ajoute le bundle `max-dev` au projet courant : ```sh climax bundles-add max-dev ``` - Ajoute le bundle `max-dev` à un projet choisi par chemin : ```sh climax bundles-add max-dev --directory /path/to/project ``` - Ajoute une archive de bundle locale au projet courant : ```sh climax bundles-add ./local-bundle.zip ``` Loading @@ -144,8 +237,15 @@ Options : Supprime un bundle de la configuration du projet, puis synchronise le projet. - Supprime le bundle `max-dev` du projet courant : ```sh climax bundles-remove max-dev ``` - Supprime le bundle `max-dev` d'un projet choisi par chemin : ```sh climax bundles-remove max-dev --directory /path/to/project ``` Loading @@ -157,21 +257,33 @@ Options : Charge un fichier XML ou un dossier dans la base BaseX `max`. - Charge un fichier XML dans la base `max` du projet courant : ```sh climax feed ./document.xml ``` - Charge un dossier dans la base `max` et passe les confirmations : ```sh climax feed ./xml-directory --yes ``` - Charge un fichier XML pour un projet choisi par chemin et affiche la commande BaseX : ```sh 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 stocké sous `chapter1.xml`. Si une ressource du même nom existe déjà 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 du contenu de la base, donc climax demande une confirmation avant d'exécuter 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. Loading @@ -183,16 +295,23 @@ du fichier ou du dossier importé. Options : - `--directory <path>` : dossier du projet MaX. - `--verbose` : affiche la commande BaseX executée. - `--verbose` : affiche la commande BaseX exécutée. - `--yes`, `-y` : supprime les confirmations de remplacement. ## sync Installe ou rafraichit `.max`, BaseX, les fichiers MaX, les ressources et les bundles configures. Installe ou rafraîchit `.max`, BaseX, les fichiers MaX, les ressources et les bundles configurés. - Synchronise le projet courant : ```sh climax sync ``` - Synchronise un projet choisi par chemin : ```sh climax sync --directory /path/to/project ``` Loading @@ -202,7 +321,7 @@ Options : ## run Execute un script XQuery d'un bundle actif. Le format de cible est Exécute un script XQuery d'un bundle actif. Le format de cible est `<bundle>/<script>`. Le script est résolu sous : ```text Loading @@ -213,10 +332,27 @@ 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. - Exécute le script `helloworld` du bundle actif `max-dev` : ```sh climax run max-dev/helloworld ``` - Exécute un script avec des bindings de variables externes : ```sh climax run max-dev/helloworld -name Alice -count 3 ``` - Passe un binding de variable externe booléen : ```sh climax run max-dev/helloworld --dry-run ``` - Exécute un script de bundle pour un projet choisi par chemin : ```sh climax run --directory /path/to/project max-dev/helloworld -name Alice ``` Loading @@ -240,28 +376,50 @@ return concat("Hello ", $name, "!") Options : - `--directory <path>` : dossier du projet MaX. Cette option doit apparaitre - `--directory <path>` : dossier du projet MaX. Cette option doit apparaître 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 options inconnues à BaseX. `--help` est aussi transmis à BaseX ; utilisez `climax help basex` pour afficher l'aide locale de climax. - Ouvre le shell BaseX pour le projet courant : ```sh climax basex ``` - Ouvre le shell BaseX pour un projet choisi par chemin : ```sh climax basex --directory /path/to/project ``` - Affiche l'aide propre à BaseX : ```sh climax basex -h ``` - Exécute une requête BaseX : ```sh climax basex -q "1 + 1" ``` - Exécute une requête BaseX avec une option de sérialisation : ```sh 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. - `--verbose` : affiche la commande Java/BaseX exécutée. Tous les autres arguments sont transmis à BaseX exactement comme ils sont écrits. Climax ne traduit pas les options longues de style GNU en options Loading @@ -272,9 +430,21 @@ et `-s`. Lance la classe GUI BaseX (`org.basex.BaseXGUI`) pour le projet courant. - Lance l'interface graphique BaseX pour le projet courant : ```sh climax basex-gui ``` - Lance l'interface graphique BaseX pour un projet choisi par chemin : ```sh climax basex-gui --directory /path/to/project ``` - Affiche la commande Java/BaseX avant de lancer l'interface graphique : ```sh climax basex-gui --verbose ``` Loading @@ -285,11 +455,18 @@ Options : ## templates-list Liste les fichiers de templates du bundle de vocabulaire configure. La sortie Liste les fichiers de templates du bundle de vocabulaire configuré. La sortie est une liste simple de chemins, une ligne par chemin. - Liste les fichiers de templates du projet courant : ```sh climax templates-list ``` - Liste les fichiers de templates d'un projet choisi par chemin : ```sh climax templates-list --directory /path/to/project ``` Loading @@ -299,11 +476,18 @@ Options : ## static-list Liste les fichiers statiques du bundle de vocabulaire configure. La sortie est Liste les fichiers statiques du bundle de vocabulaire configuré. La sortie est une liste simple de chemins, une ligne par chemin. - Liste les fichiers statiques du projet courant : ```sh climax static-list ``` - Liste les fichiers statiques d'un projet choisi par chemin : ```sh climax static-list --directory /path/to/project ``` Loading @@ -316,8 +500,15 @@ Options : Liste les projets connus de climax. La sortie par défaut est un tableau stylisé. - Liste les projets connus sous forme de tableau stylisé : ```sh climax projects ``` - Produit les projets connus en JSON : ```sh climax projects --json-out ``` Loading @@ -329,6 +520,8 @@ Options : Vide le cache des artefacts téléchargés pour MaX/BaseX. - Vide le cache des téléchargements utilisés par climax : ```sh climax cache-clear ``` Loading @@ -337,6 +530,8 @@ climax cache-clear Affiche la version de climax. - Affiche la version installée de climax : ```sh climax version ```
commands.md +195 −0 Changes for commands.md: 195 added lines, 0 removed lines. Original line number Diff line number Diff line Loading @@ -14,9 +14,21 @@ Global options: Create a new MaX project, or initialize the current directory. - Initialize the current directory as a MaX project: ```sh climax new ``` - Create a MaX project at a specific path: ```sh climax new /path/to/project ``` - Create a project and choose project values from prompts: ```sh climax new /path/to/project --interactive ``` Loading @@ -28,8 +40,15 @@ Options: Install the demo edition into an existing MaX project. - Install the demo edition in the current project: ```sh climax demo ``` - Install the demo edition in a project selected by path: ```sh climax demo --directory /path/to/project ``` Loading @@ -41,10 +60,27 @@ Options: Start the MaX HTTP/BaseX stack. - Start the current project with the configured ports: ```sh climax start ``` - Start with explicit HTTP and stop ports: ```sh climax start --http-port 8088 --http-stop-port 8089 ``` - Bind HTTP to a specific host and use a specific BaseX port: ```sh climax start --http-host 127.0.0.1 --basex-port 1984 ``` - Start MaX as a service process: ```sh climax start --service ``` Loading @@ -61,9 +97,21 @@ Options: Stop a running MaX instance. - Stop the current project's running MaX instance: ```sh climax stop ``` - Stop an instance by using an explicit stop port: ```sh climax stop --http-stop-port 8089 ``` - Stop the instance for a project selected by path: ```sh climax stop --directory /path/to/project ``` Loading @@ -76,9 +124,21 @@ Options: Show MaX project configuration. The default output is a styled table. - Show the current project's configuration as a styled table: ```sh climax info ``` - Show configuration for a project selected by path: ```sh climax info --directory /path/to/project ``` - Emit the current project's configuration as JSON: ```sh climax info --json-out ``` Loading @@ -97,9 +157,21 @@ After the crawl, `freeze` also copies the `static` directory of every configured bundle from `.max/basex/webapp/max/bundles/<bundle>/static` to `<output>/<bundle>/static`. Files already written during the crawl are kept. - Freeze the current project into `./site`: ```sh climax freeze --output ./site ``` - Freeze a project selected by path into `/tmp/site`: ```sh climax freeze --directory /path/to/project --output /tmp/site ``` - Keep debug output enabled while freezing: ```sh climax freeze --output ./site --debug ``` Loading @@ -112,9 +184,18 @@ Options: ## bundles-list List available and configured bundles. Output keeps the existing table style. A bundle is a MaX extension package that can add templates, static assets, scripts, or other project resources. - List bundles for the current project: ```sh climax bundles-list ``` - List bundles for a project selected by path: ```sh climax bundles-list --directory /path/to/project ``` Loading @@ -126,9 +207,21 @@ Options: Add a bundle to the project configuration, then sync the project. - Add the `max-dev` bundle to the current project: ```sh climax bundles-add max-dev ``` - Add the `max-dev` bundle to a project selected by path: ```sh climax bundles-add max-dev --directory /path/to/project ``` - Add a local bundle archive to the current project: ```sh climax bundles-add ./local-bundle.zip ``` Loading @@ -140,8 +233,15 @@ Options: Remove a bundle from the project configuration, then sync the project. - Remove the `max-dev` bundle from the current project: ```sh climax bundles-remove max-dev ``` - Remove the `max-dev` bundle from a project selected by path: ```sh climax bundles-remove max-dev --directory /path/to/project ``` Loading @@ -153,9 +253,21 @@ Options: Load an XML file or directory into the BaseX `max` database. - Load one XML file into the current project's `max` database: ```sh climax feed ./document.xml ``` - Load a directory into the `max` database and skip confirmation prompts: ```sh climax feed ./xml-directory --yes ``` - Load one XML file for a project selected by path and print the BaseX command: ```sh climax feed ./document.xml --directory /path/to/project --verbose ``` Loading Loading @@ -186,8 +298,15 @@ Options: Install or refresh `.max`, BaseX, MaX files, resources, and configured bundles. - Sync the current project: ```sh climax sync ``` - Sync a project selected by path: ```sh climax sync --directory /path/to/project ``` Loading @@ -208,10 +327,27 @@ The bundle must be active: its bundle directory must exist and must not contain a `.ignore` file. Script arguments after the target are converted to BaseX external variable bindings. - Run the `helloworld` script from the active `max-dev` bundle: ```sh climax run max-dev/helloworld ``` - Run a script with external variable bindings: ```sh climax run max-dev/helloworld -name Alice -count 3 ``` - Pass a boolean external variable binding: ```sh climax run max-dev/helloworld --dry-run ``` - Run a bundle script for a project selected by path: ```sh climax run --directory /path/to/project max-dev/helloworld -name Alice ``` Loading Loading @@ -245,11 +381,33 @@ Unlike normal climax commands, this command forwards unknown flags to BaseX. `--help` is also forwarded to BaseX; use `climax help basex` for local climax help. - Open the BaseX shell for the current project: ```sh climax basex ``` - Open the BaseX shell for a project selected by path: ```sh climax basex --directory /path/to/project ``` - Show BaseX's own help: ```sh climax basex -h ``` - Run a BaseX query: ```sh climax basex -q "1 + 1" ``` - Run a BaseX query with a serialization option: ```sh climax basex -s method=json -q "map { 'ok': true() }" ``` Loading @@ -266,9 +424,21 @@ names, such as `-h`, `-q`, `-Q`, `-b`, and `-s`. Launch the BaseX GUI class (`org.basex.BaseXGUI`) for the current project. - Launch the BaseX GUI for the current project: ```sh climax basex-gui ``` - Launch the BaseX GUI for a project selected by path: ```sh climax basex-gui --directory /path/to/project ``` - Print the Java/BaseX command before launching the GUI: ```sh climax basex-gui --verbose ``` Loading @@ -282,8 +452,15 @@ Options: List template files from the configured vocabulary bundle. Output is plain line-by-line paths. - List template files for the current project: ```sh climax templates-list ``` - List template files for a project selected by path: ```sh climax templates-list --directory /path/to/project ``` Loading @@ -296,8 +473,15 @@ Options: List static files from the configured vocabulary bundle. Output is plain line-by-line paths. - List static files for the current project: ```sh climax static-list ``` - List static files for a project selected by path: ```sh climax static-list --directory /path/to/project ``` Loading @@ -309,8 +493,15 @@ Options: List projects known to climax. The default output is a styled table. - List known projects as a styled table: ```sh climax projects ``` - Emit known projects as JSON: ```sh climax projects --json-out ``` Loading @@ -322,6 +513,8 @@ Options: Clear cached MaX/BaseX download artifacts. - Clear cached downloads used by climax: ```sh climax cache-clear ``` Loading @@ -330,6 +523,8 @@ climax cache-clear Print the climax version. - Print the installed climax version: ```sh climax version ```