Talaxie CLI - Documentation

Vue d'ensemble & Utilisation

L'application CLI Generator de Talaxie permet d'exécuter des tâches d'importation, de mise à jour des métadonnées, de génération de code et de build de jobs en mode ligne de commande.

Syntaxe & Exécutables

Selon votre installation, vous pouvez lancer l'application avec l'exécutable direct `TOS_CLI_GENc.exe` ou en passant par l'exécutable principal `TOS_DIc.exe` :

Option 1 : Exécutable CLI Dédié

TOS_CLI_GENc.exe [options globales] <commandes> [options de commande]

Option 2 : Via le produit Studio principal

TOS_DIc.exe -product org.talaxie.cli.branding.generator.product [options globales] <commandes> [options de commande]

info Astuce : Plusieurs commandes peuvent être enchaînées au cours d'une même exécution (ex: -import ... -editProperties ... -generate ... -build ...).

Options Globales

Ces options s'appliquent à l'application dans son ensemble lors du lancement.

Option	Option Longue	Description	Requis
-data <path>	-	Chemin vers l'espace de travail (workspace) Talaxie à utiliser (ex: `C:/TOS_DI-X.Y.Z/workspace`).	Oui
--h	--help	Affiche le message d'aide et la liste des commandes disponibles.	Non

Commandes Disponibles

Détail des commandes disponibles : -import, -editProperties, -generate et -build.

-import

-import (Importer un projet)

Importe un projet complet dans l'espace de travail depuis une archive zip.

Option	Option Longue	Description	Requis
--p <name>	--project <name>	Nom du projet cible où importer les éléments (nouveau projet ou existant).	Oui
--f <path>	--file <path>	Chemin complet du fichier ZIP du projet (ex: `C:/Downloads/OnBoardingDemoJob_0.2.zip`).	Oui
--o	--overwrite	Écrase les éléments du projet s'ils existent déjà (Ignoré pour les nouveaux projets).	Non
--m	--migrate	Exécute les migrations sur les éléments du projet pendant l'importation.	Non

-editProperties

-editProperties (Éditer les propriétés d'un élément)

Modifie les propriétés d'un élément du projet (version, nom, objectif, description).

Option	Option Longue	Description	Requis
--p <name>	--project <name>	Nom du projet existant dans lequel chercher l'élément.	Oui
--i <path>	--item <path>	Chemin fonctionnel vers l'élément (ex: `process/myFolder/myJob`). Le préfixe indique le type d'élément (`process/`, `context/`, `code/routines/`, `documentations/`), suivi des dossiers et du nom de l'élément.	Oui
-	--updateMinor	Incrémente la version mineure dans les propriétés de l'élément (Ignoré si `--updateMajor` est utilisé).	Non
-	--updateMajor	Incrémente la version majeure dans les propriétés de l'élément.	Non
-	--name <value>	Met à jour le nom de l'élément.	Non
-	--purpose <value>	Met à jour l'objectif (purpose) dans les propriétés de l'élément.	Non
-	--description <value>	Met à jour la description dans les propriétés de l'élément.	Non

-generate

-generate (Générer le code)

Génère le code source associé à un processus/job.

Option	Option Longue	Description	Requis
--p <name>	--project <name>	Nom du projet (nécessaire lors de l'utilisation d'un chemin fonctionnel avec `--process`).	Selon mode
--process <path>	-	Chemin du process à générer. (ex: `/process/myFolder/myJob`).	Oui

-build

-build (Builder un job)

Compile et extrait les jobs sous forme d'une archive ZIP autonome.

Option	Option Longue	Description	Requis / Défaut
--o <path>	--output <path>	Chemin complet du fichier ZIP de sortie ou dossier destination.	Oui
--p <name>	--project <name>	Nom du projet existant à builder.	Oui
--j <name>	--jobName <name>	Nom du job à builder (ex: `OnBoardingDemoJob`). Si absent, tous les jobs sont buildés. Accepte une liste séparée par des virgules.	Tous
--v <version>	--jobVersion <ver>	Version spécifique du job à builder (lorsqu'un seul job est spécifié).	Dernière
--c <context>	--context <name>	Nom du contexte d'exécution à intégrer au job buildé.	Default
--t	--executeTests	Exécute les tests unitaires pendant le build.	false
--ts	--includeTestSource	Inclut le code source des tests dans l'archive du job.	false
--noNeedTalendLibraries		Exclut les bibliothèques Talend du build.	false
--noNeedSourceCode		Exclut le code source Java du build final.	false
--noNeedDependencies		Exclut les dépendances de bibliothèques du build.	false
--noBinaries		Ne compile pas et ne génère pas les fichiers binaires (.class / .jar).	false
--noIncludeLibs		N'inclut pas les librairies JAR dans le package final.	false

Exemples & Automatisation

Enchaînement de commandes

Importer un projet, mettre à jour la version mineure d'un job, générer son code via son chemin fonctionnel, puis le builder :

TOS_CLI_GENc.exe ^
  -data "C:/Talaxie/workspace" ^
  -import --p "DEMO_PROJECT" --f "C:/Imports/Demo_0.1.zip" --o ^
  -editProperties --p "DEMO_PROJECT" --i "process/Job5/JOB05_000_JobEtl_Master" --updateMinor ^
  -generate --p "DEMO_PROJECT" --process "process/Job5/JOB05_000_JobEtl_Master" ^
  -build --p "DEMO_PROJECT" --j "JOB05_000_JobEtl_Master" --c "Production" --o "C:/Builds/JobEtl_Master.zip"

Intégration dans un Pipeline CI/CD

Exemple d'exécution rapide dans un script de CI/CD (ex: Bash / Jenkins / GitHub Actions) :

./TOS_DIc.exe -product org.talaxie.cli.branding.generator.product \
  -data "./workspace" \
  -build --project "MY_ETL_PROJECT" \
         --jobName "Job_Export_Sales,Job_Import_Users" \
         --output "./dist/" \
         --executeTests

Documentation CLI Generator Talaxie