Raccourcis : Contenu - rubriques - sous rubriques
EN FR

Lancer jelix.php

Jelix est fourni avec un script, lib/jelix-scripts/jelix.php, qui permet de créer et modifier facilement des éléments d'un projet jelix, ou de réaliser des actions sur le projet.

Il faut appeler ce script à partir d'une console, en ligne de commande, avec la version CLI de PHP.

Ouvrez donc une console, allez dans le répertoire lib/jelix-scripts/ :


   cd lib/jelix-scripts/      # sous linux
   cd lib\jelix-scripts\      # sous windows

Ensuite, vous pouvez exécuter une commande jelix selon cette syntaxe :


# sous windows
> php.exe jelix.php [--application_name] command_name [options] [parameters]

# sous linux
$ php jelix.php [--application_name] command_name [options] [parameters]

Vous devez toujours appeler jelix.php avec un nom de "commande jelix", accompagné éventuellement de paramètres et options.

Par exemple, pour avoir de l'aide sur toutes les commandes (et avoir la liste des commandes possibles), utilisez la commande help :


   php jelix.php help

Il y a un autre paramètre à indiquer pour la plupart des commandes jelix : le nom de l'application. C'est toujours le premier paramètre, et doit commencer par --. Exemple :


  php jelix.php --myapp createapp

Il est possible d'éviter de taper ce nom d'application à chaque fois. Pour cela, vous devez créer une variable d'environnement JELIX_APP_NAME contenant le nom de l'application.

Par exemple, tapez ceci dans la console :


  export JELIX_APP_NAME="myapp"        # sous linux
  set JELIX_APP_NAME=myapp             # sous windows

Et ainsi vous pouvez taper une commande jelix sans le nom de l'application, par exemple :


  php jelix.php createapp

Notez aussi que vous pouvez executez le script jelix.php à partir de n'importe quel répertoire. Exemple :


  php jelix/path/lib/jelix-scripts/jelix.php --myapp createapp

Changer la configuration par défaut

Les commandes de création d'application, de module etc respectent une arborescence précise. Mais ce n'est pas forcément celle que vous voulez utiliser. Il y a aussi des informations qui sont insérées dans les fichiers crées, notamment dans les commentaires d'en-tête, comme par exemple le nom de l'auteur, le site web etc. Vous pouvez changer cela.

Pour ce faire, dans lib/jelix-scripts/, il y a un fichier scripts.conf.php.dist. Renommez le en scripts.conf.php, et modifiez son contenu en décommentant les lignes que vous souhaitez et en modifiant les valeurs.

Vous pouvez aussi indiquer un autre fichier de configuration en indiquant son chemin dans la variable d'environnement JELIX_CONFIG.

Liste des commandes disponibles

Voici une liste non exhaustive des commandes pour jelix-scripts

  • Création d'une application

php jelix.php --[Monapplication] createapp
  • Création d'un module

php jelix.php --[Monapplication] createmodule [MonModule]
  • Création d'un dao

php jelix.php --[Monapplication] createdao [MonModule] [MonDao] [MaTable]