Copyright © Xerox Corporation, Codendi Team, 2001-2006. All Rights Reserved
 Documentation de l'Interface en Ligne de Commande (CLI) TuleapVersion 1.5.2 22-Apr-2013
Auteurs Marc Nazarian | | Xerox, Marc.Nazarian@xrce.xerox.com
| Hatem Ounis | | STMicroelectronics, hatem.ounis@st.com
| Nouha Terzi | | STMicroelectronics, nouha.terzi@st.com
| Manuel Vacelet | | Enalean, manuel.vacelet@enalean.com
|
This document is licensed under the GNU General Public License version 2. Portion of this documentation is inspired from the GForge Command-line Interface documentation contained in GForge. Copyright 2005 GForge, LLC http://gforge.org/ Xerox ®, The Document Company ®, and all Xerox products mentioned
in this publication are trademarks of Xerox Corporation. This document was formatted with the DocBook XML DTD. HTML
version rendered with DocBook HTML native renderer. PDF version
rendered with Apache FOP. Les exemples illustrés dans ce document sont dans certains cas différents du résultat réel. Copyright © 2011 STMicroelectronics, Tuleap.
Pour installer le client en ligne de commande Tuleap,
vous devez disposer de PHP5 installé sur votre machine
(Le CLI ne fonctionnera pas avec PHP4).
La dernière version de PHP5 est grandement recommandée.
PHP doit également avoir été compilé sans le paramètre
--disable-cli pour pouvoir être exécuté en ligne de commande. Vous devez vérifier dans quel répertoire se trouve
l'exécutable PHP installé sur votre machine. Le répertoire
est celui spécifié lors de la compilation de PHP (si aucun
préfixe n'a été spécifié, celui par défaut est /usr,
l'exécutable PHP devrait donc se trouver dans /usr/bin/php).
Comment savoir ou se trouve l'exécutable PHP ?Vous pouvez vérifier dans quel répertoire PHP est
installé en executant la commande suivante :
# which php
/usr/bin/php
Dans ce cas, l'exécutable PHP est /usr/bin/php.
|
 | Si vous prévoyez d'utiliser le client en Ligne de Commande
pour administrer une installation de Tuleap via une connection HTTPS,
vous devez compiler PHP avec l'extension CURL (en utilisant l'option
--with-curl dans le script de configuration). |
Une fois que PHP est proprement installé, vous pouvez télécharger
et décompresser le client en ligne de commande dans un répertoire sur
votre machine locale. Après avoir décompressé le client en ligne de commande, vous devez
éditer le fichier $PREFIX/tuleap.php (où $PREFIX est le répertoire dans
lequel le client a été décompressé) avec votre éditeur préféré et modifier
les choses suivantes :
Changer la première ligne, qui est :
#!/usr/bin/php -q
pour la faire pointer sur le chemin de l'exécutable PHP de votre machine.
(si il est différent de /usr/bin/php)
Trouver la section Configuration dans le script (délimitée par des commentaires)
et modifier les constantes suivantes :
CODENDI_CLI_DIR: Pointe vers le répertoire dans lequel se
trouvent les fichiers nécessaires au client. Habituellement,
il s'agit de $PREFIX/include/.
WSDL_URL (optionel): l'URL du WSDL de votre serveur Tuleap SOAP.
L'URL est très certainement http://tuleap.net/soap/index.php?wsdl.
Vous pouvez vérifier l'exactitude de l'URL en la tapant dans votre navigateur,
vous devriez alors obtenir un fichier XML renvoyé par le serveur.
Si les variables ne sont pas affectées, le client essaiera d'utiliser
le WSDL spécifié dans la variable d'environement TULEAP_WSDL.
Assurez-vous que le script tuleap.php ait bien les droits d'exécution.
Sinon, donnez-les lui en exécutant la commande suivante :
chmod +x $PREFIX/tuleap.php
Quand tout est installé correctement, vous pouvez tester l'installation
pour voir si tout fonctionne correctement. Pour cela, essayer de vous
connecter au serveur en exécutant la commande de "login". Placez-vous
tout d'abord dans le répertoire dans lequel vous avez décompressé le
client, et exécutez la commande suivante :
[mnazaria@linux tuleap-cli]$ ./tuleap.php -v login --username=(votre nom d'utilisateur) --password=(votre mot de passe)
CodendiSOAP::Connecting to the server http://tuleap.net/soap/index.php?wsdl...
CodendiSOAP::Connected!
CodendiSOAP::Executing command login...
Logged in as user (your user) , using session string MTAyLSotMTEyMzA4Mjg5My0qLTEyNy4wLjAuMS0qLU51U09BUC8wLjYuOSAoMS4xLjEuMSk=824c9f9010931f7872f4b9826c460ed3
Logged in.
|
Exemple 1. commande de login
Le message peut varier selon la configuration de votre serveur.
Si vous obtenez une erreur ressemblant à :
"Fatal error: wsdl error: HTTP ERROR: Couldn't open socket connection to
server http://tuleap.net prior to connect().",
cela veut dire que votre ordinateur n'arrive pas à se connecter au
serveur Tuleap. Dans ce cas, vous devez vous assurer que l'adresse du serveur est
correcte et que vous pouvez bien vous connecter au serveur depuis votre ordinateur.
La ligne de commande type pour appeler le client est la suivante :
# ./tuleap.php [options du programme] [nom du module] [nom de la fonction]
[paramètres de la fonction]
Options du programme :
-v : Verbose. Donne des détails en sortie sur ce qu'il se passe. -h: Help. Affiche l'aide à propos de l'utilisation du programme. --retry N: Retente l'opération N fois (Defaut: 0).
Si un appel à une méthode de l'API SOAP échoue à cause d'un problème réseau,
l'appel en question est ré-exécuté jusqu'a ce qu'il réussisse ou que le nombre
maximum de tentatives (N) est atteint.
Cette option ne présente pas de risque avec les opérations en lecture (Get*) mais
il est conseillé d'être prudent avec les opérations en écriture (Add*/Update*/Delete*).
Nom du module : Un "module" est un groupe de fonctions qui agit
sur une partie spécifique du système Tuleap. Actuellement, les
modules suivants sont disponibles :
(vide): Si le nom du module est vide, les fonctions du noyau sont accessibles. (i.e., connection au serveur) tracker: Module de gestion des Trackers frs : Module de gestion desversions de fichiers docman : Module de gestion de documents
Nom de la fonction : Le nom de la fonction à invoquer dépend
du module appelé. Pour plus de détails, voir Chapitre 3. Fonctions et paramètres des modules.
Paramètres de la fonction : Le paramètre de la fonction dépend
également de la fonction appelée. Voir Chapitre 3. Fonctions et paramètres des modules.
 | NOTE : les caractères accentués ne sont pas supportés dans le client en ligne de commande. |
 | NOTE : une étoile (*) après l'argument d'une commande signifie que cet argument est obligatoire. Par exemple 'getArtifacts --tracker_id*' signifie que la commande getArtifacts doit avoir un paramètre --tracker_id pour fonctionner correctement. |
Chapitre 3. Fonctions et paramètres des modulesCes fonctions ne font pas paeties d'un module spécifique. Les voici : login: Connection et identification au serveur.
--username: Spécifie le nom d'utilisateur avec lequel vous allez travailler.
Le nom d'utilisateur est le même que celui que vous utilisez habituellement sur
la page de connexion du site Tuleap.
--password: Spécifie le mot de passe associé au username pour vous authentifier.
Si le mot de passe n'est pas précisé, il vous sera demandé intéractivement.
--host: Spécifie le serveur Tuleap (optionnel).
--proxy: Spécifie le proxy si nécessaire (optionnel). La syntaxe est la suivante : --host=proxy_host:proxy_port
--project: nom UNIX du project sur lequel vous voulez travailler.
Si vous ne le spécifiez pas maintenant, chaque appel ultérieur de fonction
nécessitera de spécifier le projet auquel la fonction doit s'appliquer.
[ounis@linux tuleap-cli]$ ./tuleap.php login --username=john --password=johnpass --project=myproject
+---------+----------------------------------+
| user_id | session_hash |
+---------+----------------------------------+
| 103 | de6bb9f64e0ad45a0a0209f112f774f7 |
+---------+----------------------------------+
Logged in.
(OU)
[ounis@linux tuleap-cli]$ ./tuleap.php login --username=marc --project=myproject
Password:
+---------+----------------------------------+
| user_id | session_hash |
+---------+----------------------------------+
| 103 | de6bb9f64e0ad45a0a0209f112f774f7 |
+---------+----------------------------------+
Logged in.
|
Exemple 2. commande de login
logout: Termine une session. Efface toutes les informations de session de votre ordinateur.
[mnazaria@linux tuleap-cli]$ ./tuleap.php logout
Session terminated.
|
Exemple 3. commande de logout
myprojects : Affiche la liste des projets dont l'utilisateur est membre.
[ounis@linux tuleap-cli]$ ./tuleap.php myprojects
+----------+------------+-----------------+-------------+
| group_id | group_name | unix_group_name | description |
+----------+------------+-----------------+-------------+
| 104 | project 1 | project1 | project1 |
| 105 | project 2 | project2 | project2 |
| 106 | project 3 | project3 | project3 |
| 107 | project 4 | project4 | project4 |
+----------+------------+-----------------+-------------+
|
Exemple 4. commande myprojects
3.2 Fonctions des trackers
trackerlist : Affiche la liste des trackers d'un projet (sans la structure des trackers).
 | La structure des trackers n'est plus retournée par cette fonction.
Si vous souhaitez obtenir la structure de tous les trackers d'un projet,
veuillez désormais utiliser la fonction "trackers" (Section 3.2.2). |
[ounis@linux tuleap-cli]$ ./tuleap.php tracker trackerlist --project=project1
+-------------------+----------+------------------+----------------------------------------------------...
| group_artifact_id | group_id | name | description ...
+-------------------+----------+------------------+----------------------------------------------------...
| 116 | 104 | Bugs | Bugs Tracker ...
| 119 | 104 | Salome Bug | Salome Bug Tracker ...
| 120 | 104 | Scrum Backlog | Scrum backlog used to store user stories and to pla...
| 118 | 104 | Support Requests | Support Requests Tracker ...
| 117 | 104 | Tasks | Tasks Tracker ...
+-------------------+----------+------------------+----------------------------------------------------...
[1]:
+-----------+-------------------+---------+------------------------------------+-------+
| report_id | group_artifact_id | name | description | scope |
+-----------+-------------------+---------+------------------------------------+-------+
| 116 | 116 | Bugs | Bugs Report | P |
| 100 | 116 | Default | The system default artifact report | S |
+-----------+-------------------+---------+------------------------------------+-------+
[2]:
+-----------+-------------------+-------------+------------------------------------+-------+
| report_id | group_artifact_id | name | description | scope |
+-----------+-------------------+-------------+------------------------------------+-------+
| 119 | 119 | Salome Bugs | Salome Bugs Report | P |
| 100 | 119 | Default | The system default artifact report | S |
+-----------+-------------------+-------------+------------------------------------+-------+
[3]:
+-----------+-------------------+---------+------------------------------------+-------+
| report_id | group_artifact_id | name | description | scope |
+-----------+-------------------+---------+------------------------------------+-------+
| 120 | 120 | Scrum | Scrum Report | P |
| 100 | 120 | Default | The system default artifact report | S |
+-----------+-------------------+---------+------------------------------------+-------+
[4]:
+-----------+-------------------+---------+------------------------------------+-------+
| report_id | group_artifact_id | name | description | scope |
+-----------+-------------------+---------+------------------------------------+-------+
| 118 | 118 | SR | Support Requests Report | P |
| 100 | 118 | Default | The system default artifact report | S |
+-----------+-------------------+---------+------------------------------------+-------+
[5]:
+-----------+-------------------+---------+------------------------------------+-------+
| report_id | group_artifact_id | name | description | scope |
+-----------+-------------------+---------+------------------------------------+-------+
| 117 | 117 | Tasks | Tasks Report | P |
| 100 | 117 | Default | The system default artifact report | S |
+-----------+-------------------+---------+------------------------------------+-------+
|
Exemple 5. commande trackerlist
trackers : Affiche la liste des trackers d'un projet (avec leur structure).
 | Comme cette fonction retourne toute la structure de tous les trackers d'un projet,
il se peut qu'elle devienne un peu lente avec des projets contenant beaucoup de trackers.
Le cas échéant, vous pouvez utiliser la fonction "trackerlist", (voir Section 3.2.1)
suivie de la fonction "tracker" (Section 3.2.3)
pour obtenir la structure du tracker souhaité.
|
[ounis@linux tuleap-cli]$ ./tuleap.php tracker trackers --project=project1
+-------------------+----------+------------------+----------------------------------------------------...
| group_artifact_id | group_id | name | description ...
+-------------------+----------+------------------+----------------------------------------------------...
| 116 | 104 | Bugs | Bugs Tracker ...
| 119 | 104 | Salome Bug | Salome Bug Tracker ...
| 120 | 104 | Scrum Backlog | Scrum backlog used to store user stories and to pla...
| 118 | 104 | Support Requests | Support Requests Tracker ...
| 117 | 104 | Tasks | Tasks Tracker ...
+-------------------+----------+------------------+----------------------------------------------------...
[13]:
+----------+-------------------+----------+-------+-------------+----------+--------+
| field_id | group_artifact_id | value_id | value | description | order_id | status |
+----------+-------------------+----------+-------+-------------+----------+--------+
| 10 | 116 | 100 | None | | 10 | P |
+----------+-------------------+----------+-------+-------------+----------+--------+
[14]:
+----------+-------------------+----------+-------+-------------+----------+--------+
| field_id | group_artifact_id | value_id | value | description | order_id | status |
+----------+-------------------+----------+-------+-------------+----------+--------+
| 7 | 116 | 103 | ounis | | 0 | |
| 7 | 116 | 100 | None | | 10 | P |
+----------+-------------------+----------+-------+-------------+----------+--------+
[15]:
No results
(... liste des trackers, des field sets et des fields ...)
|
Exemple 6. commande trackers
tracker : Affiche la structure d'un tracker.
--tracker_id* : ID du tracker. --project: nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié
lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login,
une erreur sera affichée.
[ounis@linux tuleap-cli]$ ./tuleap.php tracker tracker --project=project1 --tracker_id=116
+-------------------+----------+------+--------------+-----------+------------+-------------+----------...
| group_artifact_id | group_id | name | description | item_name | open_count | total_count | total_fil...
+-------------------+----------+------+--------------+-----------+------------+-------------+----------...
| 116 | 104 | Bugs | Bugs Tracker | bug | -1 | 1 | 0 ...
+-------------------+----------+------+--------------+-----------+------------+-------------+----------...
[1]:
+--------------+-------------------+-------------------------------+---------+-------------------------...
| field_set_id | group_artifact_id | name | label | description ...
+--------------+-------------------+-------------------------------+---------+-------------------------...
| 49 | 116 | fieldset_default_bugs_lbl_key | Details | fieldset_default_bugs_de...
| 50 | 116 | fieldset_status_bugs_lbl_key | Status | fieldset_status_bugs_des...
+--------------+-------------------+-------------------------------+---------+-------------------------...
(... liste des des field sets et des fields ...)
|
Exemple 7. commande tracker
list: Affiche la liste des artefacts appartenant au tracker spécifié.
--tracker_id* : ID du tracker. --limit: Nombre maximum d'artefacts retournés. --offset: Nombre d'artefacts qui seront "sautés" (ce paramètre ne peut pas être utilisé seul, il doit être accompagné du paramètre limit). --[nom du champ][opérateur][valeur]: critère de filtre pour les artefacts retournés. Fonctionne avec les champs standards et les champs utilisateurs. Exemple : "--open_date>2006-05-21" --assigned_to=135 --status_id=0. Les opérateurs autorisés sont >, >=, =, <, <=, <>. --project: nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié
lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login,
une erreur sera affichée.
[ounis@linux tuleap-cli]$ ./tuleap.php tracker list --tracker_id=116
+------------------------+-----------+
| total_artifacts_number | artifacts |
+------------------------+-----------+
| 1 | [1] |
+------------------------+-----------+
[1]:
+-------------+-------------------+-----------+--------------+------------+------------+---------------...
| artifact_id | group_artifact_id | status_id | submitted_by | open_date | close_date | last_update_da...
+-------------+-------------------+-----------+--------------+------------+------------+---------------...
| 2 | 116 | 3 | 103 | 1289480620 | 1291276352 | 1291276353 ...
+-------------+-------------------+-----------+--------------+------------+------------+---------------...
[1]:
+----------+-------------+-------------+
| field_id | artifact_id | field_value |
+----------+-------------+-------------+
| 3 | 2 | 100 |
| 4 | 2 | 100 |
| 16 | 2 | 100 |
| 20 | 2 | 100 |
+----------+-------------+-------------+
|
Exemple 8. commande list
reportlist: Affiche la liste des artefacts appartenant au tracker spécifié, selon le rapport spécifié.
--tracker_id* : ID du tracker. --limit: Nombre maximum d'artefacts retournés. --offset: Nombre d'artefacts qui seront "sautés" (ce paramètre ne peut pas être utilisé seul, il doit être accompagné du paramètre limit). --[nom du champ][opérateur][valeur]: critère de filtre pour les artefacts retournés. Fonctionne avec les champs standards et les champs utilisateurs. Exemple : "--open_date>2006-05-21" --assigned_to=135 --status_id=0. Les opérateurs autorisés sont >, >=, =, <, <=, <>. --sort={[nom du champ] [direction du tri]}*: critère de tri pour classer les artefacts retournés. Fonctionne avec les champs standards et les champs utilisateurs. Exemple : --sort="severity DESC, open_date DESC, artifact_id ASC". Les directions autorisées sont ASC (ascendant) et DESC (descendant). --project: nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié
lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login,
une erreur sera affichée.
[ounis@linux tuleap-cli]$ ./tuleap.php tracker reportlist --tracker_id=116
+------------------------+-----------+
| total_artifacts_number | artifacts |
+------------------------+-----------+
| 1 | [1] |
+------------------------+-----------+
[1]:
+-------------+----------+--------+
| artifact_id | severity | fields |
+-------------+----------+--------+
| 2 | 5 | [1] |
+-------------+----------+--------+
[1]:
+--------------+---------------+
| field_name | field_value |
+--------------+---------------+
| artifact_id | 2 |
| summary | bug |
| open_date | 1289480620 |
| assigned_to | None |
| submitted_by | ounis |
+--------------+---------------+
|
Exemple 9. commande reportlist
reports: Affiche tous les rapports d'un tracker donné.
--tracker_id* : ID du tracker. --project : nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié
lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login,
une erreur sera affichée.
[ounis@linux tuleap-cli]$ ./tuleap.php tracker reports --tracker_id=116
+-----------+-------------------+---------+------------------------------------+-------+--------+
| report_id | group_artifact_id | name | description | scope | fields |
+-----------+-------------------+---------+------------------------------------+-------+--------+
| 116 | 116 | Bugs | Bugs Report | P | [1] |
| 100 | 116 | Default | The system default artifact report | S | [2] |
+-----------+-------------------+---------+------------------------------------+-------+--------+
[1]:
+-----------+--------------+---------------+----------------+-------------+--------------+-----------+
| report_id | field_name | show_on_query | show_on_result | place_query | place_result | col_width |
+-----------+--------------+---------------+----------------+-------------+--------------+-----------+
| 116 | status_id | 1 | 0 | 40 | 0 | 0 |
| 116 | bug_group_id | 1 | 0 | 20 | 0 | 0 |
| 116 | category_id | 1 | 0 | 10 | 0 | 0 |
| 116 | artifact_id | 0 | 1 | 0 | 10 | 0 |
| 116 | summary | 0 | 1 | 0 | 20 | 0 |
| 116 | open_date | 0 | 1 | 0 | 30 | 0 |
| 116 | assigned_to | 1 | 1 | 30 | 40 | 0 |
| 116 | submitted_by | 0 | 1 | 0 | 50 | 0 |
+-----------+--------------+---------------+----------------+-------------+--------------+-----------+
[2]:
+-----------+--------------+---------------+----------------+-------------+--------------+-----------+
| report_id | field_name | show_on_query | show_on_result | place_query | place_result | col_width |
+-----------+--------------+---------------+----------------+-------------+--------------+-----------+
| 100 | category_id | 1 | 0 | 10 | | |
| 100 | severity | 0 | 0 | | | |
| 100 | status_id | 1 | 0 | 20 | | |
| 100 | artifact_id | 1 | 1 | 50 | 10 | |
| 100 | summary | 0 | 1 | | 20 | |
| 100 | open_date | 1 | 1 | 40 | 30 | |
| 100 | assigned_to | 1 | 1 | 30 | 40 | |
| 100 | submitted_by | 0 | 1 | | 50 | |
+-----------+--------------+---------------+----------------+-------------+--------------+-----------+
|
Exemple 10. commande reports
add: Ajoute un artefact au tracker.
--tracker_id* : ID du tracker dans lequel le nouvel artefact sera ajouté. --summary: Summary de l'artefact. --details: Details de l'artefact. --status_id: Status_id de l' artefact. --severity: Severity de l'artefact (1: basse, 9: haute). --[nom extra field]: Valeur de l'extra field. Le nom de l'extra field doit être le nom du champ (field_name). La valeur de l'extra_field dépend de son type. Pour les champs multi-valués, séparez les valeurs par une virgule. --project: nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié
lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login,
une erreur sera affichée.
[ounis@linux tuleap-cli]$ ./tuleap.php tracker add --tracker_id=116 --summary="Back button is not working" --details="When I read my email and I press the back button, a blank page appears" --severity=4 --assigned_to=103
Confirm you want to add a new artifact with the following information:
summary: Back button is not working
details: When I read my email and I press the back button, a blank page appears
severity: 4
group_id: 104
group_artifact_id: 116
assigned_to: 103
Is this information correct? (y/n): y
+--------+
| Result |
+--------+
| 40 |
+--------+
|
Exemple 11. commande add
 | Note: Dans cet exemple, "assigned_to" correspond à un extra_field et
103 est une valeur valide pour ce champ.
La valeur retournée (40) est l'identifiant du nouvel artefact.
|
update: Mise à jour de l'artefact.
--tracker_id* : ID du tracker auquel appartient l'artefact à modifier. --id* : ID de l'artefact à modifier. --status_id: Nouveau status de l'artefact. --summary: Summary de l'artefact. --details: Details de l'artefact. --severity: Severity de l'artefact (1: Basse, 9: Haute). --[nom extra_field]: Valeur de l'extra field. La valeur de l'extra field dépend de son type. --project: nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié
lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login,
une erreur sera affichée.
[ounis@linux tuleap-cli]$ ./tuleap.php tracker update --tracker_id=116 --id=40 --severity=6
Confirm you want to add a new artifact with the following information:
severity: 6
group_id: 104
group_artifact_id: 116
artifact_id: 40
Is this information correct? (y/n): y
+--------+
| Result |
+--------+
| 40 |
+--------+
|
Exemple 12. commande update
comments: Affiche tous les commentaires d'un artefatc.
--tracker_id* : ID du tracker. --id* : ID de l'artefact. --project: nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié
lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login,
une erreur sera affichée.
[ounis@linux tuleap-cli]$ ./tuleap.php tracker comments --tracker_id=116 --id=40
+-------------+--------------+------------------+------------+---------------+-------+-------------+---...
| artifact_id | follow_up_id | comment | date | original_date | by | original_by | co...
+-------------+--------------+------------------+------------+---------------+-------+-------------+---...
| 40 | 559 | Yet another one | 1293718666 | 1293718666 | ounis | ounis | 10...
| 40 | 558 | Another comment | 1293718652 | 1293718652 | ounis | ounis | 10...
| 40 | 556 | comment by ounis | 1293718608 | 1293718608 | ounis | ounis | 10...
+-------------+--------------+------------------+------------+---------------+-------+-------------+---...
|
Exemple 13. commande comments
addComment: Ajoute un commentaire à un artefact.
--tracker_id* : ID du tracker auquel appartient l'artefact. --id* : ID de l'artefact. --message* : Message du commentaire. --comment_type_id: Type à ajouter au commentaire (optionnel). --project: nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié
lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login,
une erreur sera affichée.
[ounis@linux tuleap-cli]$ ./tuleap.php tracker addComment --tracker_id=116 --id=40 --format=html --message="I agree with you"
+--------+
| Result |
+--------+
| 1 |
+--------+
|
Exemple 14. commande addComment
updateComment: Modifie le commentaire existant d'un artefact.
--tracker_id*: ID du tracker auquel appartient l'artefact. --artifact_id*: ID de l'artefact. --comment_id*: ID du commentaire à modifier. --comment*: le nouveau commentaire qui remplacera l'ancien. --format: Format du commentaire, peut etre 'text' ou 'html' (optionnel). --project: nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié
lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login,
une erreur sera affichée.
[ounis@linux tuleap-cli]$ ./tuleap.php tracker updateComment --tracker_id=116 --artifact_id=40 --comment_id=560 --comment="This comment will replace the former one"
+--------+
| Result |
+--------+
| 1 |
+--------+
|
Exemple 15. commande updateComment
deleteComment: Supprime le commentaire existant d'un artefact.
--tracker_id*: ID du tracker auquel appartient l'artefact. --artifact_id*: ID de l'artefact. --comment_id*: ID du commentaire à supprimer. --project: nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié
lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login,
une erreur sera affichée.
[ounis@linux tuleap-cli]$ ./tuleap.php tracker deleteComment --tracker_id=116 --artifact_id=40 --comment_id=560
+--------+
| Result |
+--------+
| 1 |
+--------+
|
Exemple 16. commande deleteComment
CCList: Affiche la liste des CC d'un artefact.
--tracker_id* : ID du tracker. --id* : ID de l'artefact. --project: nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié
lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login,
une erreur sera affichée.
[ounis@linux tuleap-cli]$ ./tuleap.php tracker CCList --tracker_id=116 --id=40
+----------------+-------------+----------------------+----------+---------------+---------+------------+
| artifact_cc_id | artifact_id | email | added_by | added_by_name | comment | date |
+----------------+-------------+----------------------+----------+---------------+---------+------------+
| 1 | 40 | nouha.terzi@st.com | 103 | ounis | | 1293720479 |
| 2 | 40 | ounis | 103 | ounis | | 1293720479 |
| 3 | 40 | salma.moakhar@st.com | 103 | ounis | | 1293720479 |
+----------------+-------------+----------------------+----------+---------------+---------+------------+
|
Exemple 17. commande CCList
addCC: Ajoute une liste d'adresses email ou de logins à la liste des CC d'un artefact.
--tracker_id* : ID du tracker auquel appartient l'artefact. --id* : ID de l'artefact. --cc_list*: Liste d'adresses email et/ou de logins à ajouter à la liste des CC. --cc_comment: Commentaire optionnel associé à la liste des CC ajoutés. --project: nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié
lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login,
une erreur sera affichée.
[ounis@linux tuleap-cli]$ ./tuleap.php tracker addCC --tracker_id=116 --id=40 --cc_list="nouha.terzi@st.com, ounis, salma.moakhar@st.com"
+--------+
| Result |
+--------+
| 1 |
+--------+
|
Exemple 18. commande addCC
deleteCC: Supprime un CC d'un artefact.
--tracker_id* : ID du tracker auquel appartient l'artefact. --id* : ID de l'artefact. --cc_id* : ID du CC à supprimer. --project : nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié
lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login,
une erreur sera affichée.
[ounis@linux tuleap-cli]$ ./tuleap.php tracker deleteCC --tracker_id=116 --id=40 --cc_id=2
+--------+
| Result |
+--------+
| 1 |
+--------+
|
Exemple 19. commande deleteCC
dependencies: Affiche toutes les dépendances d'un artefact.
--tracker_id* : ID du tracker. --id* : ID de l'artefact. --project : nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié
lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login,
une erreur sera affichée.
[ounis@linux tuleap-cli]$ ./tuleap.php tracker dependencies --tracker_id=116 --id=40
+--------------------+-------------+-----------------------------+-------------+------------+----------...
| artifact_depend_id | artifact_id | is_dependent_on_artifact_id | summary | tracker_id | tracker_n...
+--------------------+-------------+-----------------------------+-------------+------------+----------...
| 25 | 40 | 41 | Another bug | 116 | Bugs ...
+--------------------+-------------+-----------------------------+-------------+------------+----------...
|
Exemple 20. commande dependencies
3.2.17 inverseDependencies
inverseDependencies: Affiche toutes les dépendances inverses d'un artefact.
--tracker_id* : ID du tracker. --id* : ID de l'artefact. --project : nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié
lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login,
une erreur sera affichée.
[ounis@linux tuleap-cli]$ ./tuleap.php tracker inverseDependencies --tracker_id=116 --id=40
+--------------------+-------------+-----------------------------+-----------------+------------+------...
| artifact_depend_id | artifact_id | is_dependent_on_artifact_id | summary | tracker_id | track...
+--------------------+-------------+-----------------------------+-----------------+------------+------...
| 26 | 41 | 40 | Another bug | 116 | Bugs ...
| 27 | 42 | 40 | yet another bug | 116 | Bugs ...
+--------------------+-------------+-----------------------------+-----------------+------------+------...
|
Exemple 21. commande inverseDependencies
addDependencies: Ajoute une liste de dépendances à un artefact.
--tracker_id* : ID du tracker. --id* : ID de l'artefact. --dependencies* : liste des dépendances à ajouter, séparées par une virgule. --project : nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié
lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login,
une erreur sera affichée.
[ounis@linux tuleap-cli]$ ./tuleap.php tracker addDependencies --tracker_id=116 --id=40 --dependencies="41"
+--------+
| Result |
+--------+
| 1 |
+--------+
|
Exemple 22. commande addDependencies
deleteDependency: Supprime une dépendance à un artefact.
--tracker_id* : ID du tracker. --id* : ID de l'artefact. --dependency* : ID de la dépendace à supprimer. --project : nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié
lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login,
une erreur sera affichée.
[ounis@linux tuleap-cli]$ ./tuleap.php deleteDependency tracker --tracker_id=116 --id=40 --dependency=41
+--------+
| Result |
+--------+
| 41 |
+--------+
|
Exemple 23. commande deleteDependency
artifactHistory: Affiche l'historique des champs d'un artefact.
--tracker_id* : ID du tracker. --id* : ID de l'artefact. --project : nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié
lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login,
une erreur sera affichée.
[ounis@linux tuleap-cli]$ ./tuleap.php tracker artifactHistory --tracker_id=116 --id=40
+------------+-----------------------------------------------+-----------------------------------------...
| field_name | old_value | new_value ...
+------------+-----------------------------------------------+-----------------------------------------...
| cc | nouha.terzi@st.com,ounis,salma.moakhar@st.com | nouha.terzi@st.com,salma.moakhar@st.com ...
| cc | | nouha.terzi@st.com,ounis,salma.moakhar@s...
| comment | I agree with you | ...
| comment | I agree with you | In fact i don't agree ...
| summary | Increased priority | Back button is not working ...
| summary | Back button is not working | Increased priority ...
| severity | 4 | 6 ...
+------------+-----------------------------------------------+-----------------------------------------...
|
Exemple 24. commande artifactHistory
attachedFiles: Liste les fichiers attachés d'un artefact (le contenu des fichiers n'est pas présent).
--tracker_id* : ID du Tracker. --artifact_id* : ID de l'artefact. --project : nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié
lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login,
une erreur sera affichée.
[ounis@linux tuleap-cli]$ ./tuleap.php tracker attachedFiles --tracker_id=116 --artifact_id=40
+----+-------------+----------+-------------------+----------+----------+------------+------------+----...
| id | artifact_id | filename | description | bin_data | filesize | filetype | adddate | sub...
+----+-------------+----------+-------------------+----------+----------+------------+------------+----...
| 2 | 40 | file2 | file2 description | | 14 | text/plain | 1293721808 | oun...
| 1 | 40 | file1 | file1 description | | 14 | text/plain | 1293721737 | oun...
+----+-------------+----------+-------------------+----------+----------+------------+------------+----...
|
Exemple 25. commande attachedFiles
attachedFile: Télécharge le fichier attaché d'un artefact.
--tracker_id* : Id du Tracker. --artifact_id* : ID de l'artifact. --file_id* : ID du fichier attaché à télécharger. --output: emplacement et nom du fichier à télécharger. Si non spécifié, le contenu sera affiché à l'écran. --project : nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié
lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login,
une erreur sera affichée.
[ounis@linux tuleap-cli]$ ./tuleap.php tracker attachedFile --tracker_id=116 --artifact_id=40 --file_id=2 --output=./file2
File retrieved successfully.
|
Exemple 26. commande attachedFile
addAttachedFile: Attache un fichier à un artefact.
--tracker_id* : ID du Tracker. --artifact_id* : ID de l'artefact. --file* : fihcier local à attacher. --description: Description du fichier. --project : nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié
lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login,
une erreur sera affichée.
[ounis@linux tuleap-cli]$ ./tuleap.php tracker addAttachedFile --tracker_id=116 --artifact_id=40 --file=file2 --description="file2 description"
+--------+
| Result |
+--------+
| 2 |
+--------+
|
Exemple 27. commande addAttachedFile
 | Note : La valeur retournée (2) correspond à l'identifiant du nouveau fichier créé. |
3.2.24 deleteAttachedFile
deleteAttachedFile: Supprime un fichier attaché à un artefact.
--tracker_id*: ID du Tracker. --artifact_id*: ID de l'artefact. --file_id*: ID du fichier a supprimer. --project: nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié
lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login,
une erreur sera affichée.
[ounis@linux tuleap-cli]$ ./tuleap.php tracker deleteAttachedFile --tracker_id=116 --artifact_id=40 --file_id=2
+--------+
| Result |
+--------+
| 2 |
+--------+
|
Exemple 28. deleteAttachedFile command
 | Note: La valeur retournée (2) correspond à l'identifiant du fichier supprimé. |
3.3 Fonctions du système de gestion des fichiersLes commandes ci-après peuvent retourner les codes d'erreur suivants:
'invalid_package_fault' (code '3017'): le paquet n'existe pas 'invalid_release_fault' (code '3018'): la version n'existe pas 'invalid_file_fault' (code '3019'): le fichier n'existe pas
getPackages: Affiche une liste des paquets disponibles pour un projet
[ounis@linux tuleap-cli]$ ./tuleap.php frs getPackages --project=project1
+------------+----------+----------------+-----------+------+-----------------+
| package_id | group_id | name | status_id | rank | approve_license |
+------------+----------+----------------+-----------+------+-----------------+
| 198 | 104 | package2 | 1 | 1 | |
| 197 | 104 | my_new_package | 1 | 2 | |
+------------+----------+----------------+-----------+------+-----------------+
|
Exemple 29. commande getPackages
addPackage: Ajoute un paquet au système de gestion de fichier.
--name*: nom du nouveau paquet à ajouter.
--status_id: status_id du paquet. Par défaut, le statut est actif.
--rank: ordre d'affichage du paquet. Par défaut (si non spécifié), le rang est 0.
--approve_license: Si positionné à '1', l'utilisateur final devra approuver une license avant de pouvoir télécharger les fichiers. Sinon, le téléchargement s'effectue directement. Par défaut, la valeur est 1.
--project: nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login, une erreur sera affichée.
[ounis@linux tuleap-cli]$ ./tuleap.php frs addPackage --project=project1 --name="my_new_package" --status_id=1
+--------+
| Result |
+--------+
| 197 |
+--------+
|
Exemple 30. commande addPackage
 | Note: La valeur retournée (197) est l'identifiant du nouveau paquet créé. |
getReleases: Affiche une liste des versions disponibles pour un projet et un paquet donné.
--package_id*: l'identifiant du paquet
--project: nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login, une erreur sera affichée.
[ounis@linux tuleap-cli]$ ./tuleap.php frs getReleases --project=project1 --package_id=197
+------------+------------+---------------+--------------------------------+---------------------------...
| release_id | package_id | name | notes | changes ...
+------------+------------+---------------+--------------------------------+---------------------------...
| 144 | 197 | first version | somes notes about this release | first release ...
| 143 | 197 | new version | somes notes about this release | the changes of this new re...
+------------+------------+---------------+--------------------------------+---------------------------...
|
Exemple 31. commande getReleases
addRelease: Ajoute une version au système de gestion des fichiers.
--package_id*: l'identifiant du paquet qui contiendra la nouvelle version
--name*: nom de la nouvelle version à créer.
--notes: notes à propos de la nouvelle version
--changes: changements de cette nouvelle version
--status_id: status_id de la nouvelle version. Par défaut (si non spécifié), le statut est actif.
--release_date: date de la nouvelle version, au format YYYY-MM-DD. Par défaut, la date de la version est la date courante.
--project: nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login, une erreur sera affichée.
[ounis@linux tuleap-cli]$ ./tuleap.php frs addRelease --package_id=197 --name="new version" --notes="somes notes about this release" --changes="the changes of this new release" --status_id=1
+--------+
| Result |
+--------+
| 143 |
+--------+
|
Exemple 32. commande addRelease
 | Note: La valeur retournée (143) est l'identifiant de la nouvelle version créée. |
getFiles: Affiche une liste des fichiers disponibles pour un projet, un paquet et une version donnée.
--package_id*: l'identifiant du paquet
--release_id*: l'identifiant de la version
--project: nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login, une erreur sera affichée.
[ounis@linux tuleap-cli]$ ./tuleap.php frs getFiles --package_id=197 --release_id=143
+---------+------------+-----------------+-----------+---------+--------------+--------------+---------...
| file_id | release_id | file_name | file_size | type_id | processor_id | release_time | post_dat...
+---------+------------+-----------------+-----------+---------+--------------+--------------+---------...
| 419 | 143 | p197_r143/file1 | 14 | 9999 | 9999 | 1293787567 | 12937875...
+---------+------------+-----------------+-----------+---------+--------------+--------------+---------...
|
Exemple 33. commande getFiles
Support des gros fichiers: CLI peut ajouter des fichiers supérieurs à 2Go lorsque que la machine cliente (qui exécute CLI) et le serveur sont des machines 64 bits. Dans les autres cas, pour ajouter des fichiers > à 2Go, il faut utiliser FTP pour le transfert et l'option --uploaded_file. addFile: Ajoute un fichier au système de gestion des fichiers
--package_id*: identifiant du paquet qui contiendra le fichier
--release_id*: identifiant de la version qui contiendra le fichier
--local_file(*): emplacement (local) du fichier à ajouter. Utilisez cet argument si votre fichier est local. Votre fichier sera téléchargé sur le serveur. Au moins un des arguments --local_file ou --uploaded_file est obligatoire, selon la méthode utilisée pour ajouter votre fichier.
--uploaded_file(*): nom du fichier à ajouter. Le fichier doit déjà se trouver dans le répertoire "incoming" du serveur. Au moins un des arguments --local_file ou --uploaded_file est obligatoire, selon la méthode utilisée pour ajouter votre fichier.
--type_id: type_id du fichier
--processor_id: processor_id du fichier
--reference_md5: Le md5 du fichier se trouvant dans le répertoire "incoming" du serveur.
--comment: Un commentaire pour le nouveau fichier
--project: nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login, une erreur sera affichée.
 | Pour un fichier local le md5sum est automatiquement calculé par CLI dans la machine cliente, alors le paramètre reference_md5 n'est pris en considération que pour les fichiers uploadés dans "incoming" en utilisant ftp et il est absolument inutile de l'ajouter pour un fichier local. |
[ounis@linux tuleap-cli]$ ./tuleap.php frs addFile --package_id=197 --release_id=143 --local_file=file1
+--------+
| Result |
+--------+
| 419 |
+--------+
(pour un fichier local ou)
[ounis@linux tuleap-cli]$ ./tuleap.php frs addFile --package_id=197 --release_id=143 --uploaded_file=file2
+--------+
| Result |
+--------+
| 420 |
+--------+
(pour un fichier déjà téléchargé dans le répertoire incoming de votre serveur)
|
Exemple 34. commande addFile
 | Note: La valeur retournée (420) est l'identifiant du nouveau fichier créé. |
Support des gros fichiers: CLI peut télécharger des fichiers supérieurs à 2Go lorsque que la machine cliente (qui exécute CLI) et le serveur sont des machines 64 bits. getFile: Retourne le contenu du fichier
--package_id* : identifiant du paquet dans lequel se trouve le fichier
--release_id* : identifiant de la version dans laquelle se trouve le fichier
--file_id* : identifiant du fichier à retourner
--output : emplacement où télécharger le fichier. Si non spécifié, le contenu du fichier sera affiché sur la sortie standard.
--remote_name: Pour retrouver le nom de fichier depuis le serveur au lieu d'utiliser --output.
--project : nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login, une erreur sera affichée.
[ounis@linux tuleap-cli]$ ./tuleap.php frs getFile --package_id=197 --release_id=143 --file_id=419 --output=./downloaded_file
File retrieved successfully.
|
Exemple 35. commande getFile
 | Note : si aucune erreur n'est retournée, le fichier est correctement téléchargé. |
getUploadedFiles: Affiche une liste des fichiers uploadés avec ftp dans le répértoire incoming
[ounis@linux tuleap-cli]$ ./tuleap.php frs getUploadedFiles
+--------+
| Result |
+--------+
| file1 |
| file2 |
+--------+
|
Exemple 36. getUploadedFiles command
deleteFile: Supprime un fichier
--package_id*: identifiant du paquet dans lequel se trouve le fichier
--release_id*: identifiant de la version dans laquelle se trouve le fichier
--file_id*: identifiant du fichier à supprimer
--project: nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login, une erreur sera affichée.
[ounis@linux tuleap-cli]$ ./tuleap.php frs deleteFile --package_id=197 --release_id=143 --file_id=420
+--------+
| Result |
+--------+
| 1 |
+--------+
|
Exemple 37. deleteFile command
 | Note : la valeur retournée 1 indique que la suppression a été effectuée. Dans tous les autres cas, une erreur est retournée. |
getFileInfo: Affiche les informations relatives a un fichier donné.
--package_id*: identifiant du paquet dans lequel se trouve le fichier
--release_id*: identifiant de la version dans laquelle se trouve le fichier
--file_id*: identifiant du fichier dont on veut afficher les informations
--project: nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login, une erreur sera affichée.
[ounis@linux tuleap-cli]$ ./tuleap.php frs getFileInfo --package_id=197 --release_id=143 --file_id=419
+---------+------------+-----------------+-----------+---------+--------------+--------------+---------...
| file_id | release_id | file_name | file_size | type_id | processor_id | release_time | post_dat...
+---------+------------+-----------------+-----------+---------+--------------+--------------+---------...
| 419 | 143 | p197_r143/file1 | 14 | 9999 | 9999 | 1293787567 | 12937875...
+---------+------------+-----------------+-----------+---------+--------------+--------------+---------...
|
Exemple 38. getFileInfo command
3.3.11 deleteEmptyPackagedeleteEmptyPackage: Supprime le paquet s'il est vide
--project: Nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login, une erreur sera affichée.
--package_id*: Identifiant du paquet à supprimer.
[ounis@linux tuleap-cli]$ ./tuleap.php frs deleteEmptyPackage --package_id=288
+------------+----------+------+-----------+------+-----------------+
| package_id | group_id | name | status_id | rank | approve_license |
+------------+----------+------+-----------+------+-----------------+
| 288 | 104 | test | 1 | 5 | |
+------------+----------+------+-----------+------+-----------------+
|
Exemple 39. commande deleteEmptyPackage
 | La valeur de retour représente les détails du paquet supprimé. |
3.3.12 deleteAllEmptyPackagesdeleteAllEmptyPackages: Supprime tous les paquets vides du projet
[ounis@linux tuleap-cli]$ ./tuleap.php frs deleteAllEmptyPackages
+------------+----------+------+-----------+------+-----------------+
| package_id | group_id | name | status_id | rank | approve_license |
+------------+----------+------+-----------+------+-----------------+
| 288 | 104 | test | 1 | 5 | |
| 226 | 104 | pkg | 1 | 6 | |
+------------+----------+------+-----------+------+-----------------+
|
Exemple 40. commande deleteAllEmptyPackages
 | La valeur de retour est la liste des paquets supprimés. |
3.3.13 deleteEmptyReleasedeleteEmptyRelease: Supprime la version si elle est vide.
--project: Nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login, une erreur sera affichée.
--package_id*: Id du paquet dans lequel les versions vides seront supprimées
--release_id*: Identifiant de la version à supprimer.
[ounis@linux tuleap-cli]$ ./tuleap.php frs deleteEmptyRelease --package_id=288 --release_id=226
+------------+------------+---------------+-------+---------+-----------+--------------+-------------+
| release_id | package_id | name | notes | changes | status_id | release_date | released_by |
+------------+------------+---------------+-------+---------+-----------+--------------+-------------+
| 226 | 288 | empty release | | | 1 | 1323648000 | 103 |
+------------+------------+---------------+-------+---------+-----------+--------------+-------------+
|
Exemple 41. commande deleteEmptyRelease
 | La valeur de retour représente les détails de la version supprimée. |
3.3.14 deleteAllEmptyReleasesdeleteAllEmptyReleases: Supprime toutes les versions vides du paquet
--project: Nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login, une erreur sera affichée.
--package_id*: Id du paquet dans lequel les versions vides seront supprimées
[ounis@linux tuleap-cli]$ ./tuleap.php frs deleteAllEmptyReleases --package_id=288
+------------+------------+---------------+-------+---------+-----------+--------------+-------------+
| release_id | package_id | name | notes | changes | status_id | release_date | released_by |
+------------+------------+---------------+-------+---------+-----------+--------------+-------------+
| 226 | 288 | empty release | | | 1 | 1323648000 | 103 |
| 224 | 288 | empty | | | 1 | 1323648000 | 103 |
+------------+------------+---------------+-------+---------+-----------+--------------+-------------+
|
Exemple 42. commande deleteAllEmptyReleases
 | La valeur de retour est la liste des versions supprimées. |
3.4 Fonction du Gestionnaire de DocumentsCe module fonctionne avec le plugin docman et nécessite que le plugin soit installé. list : Affiche la liste des items contenus dans un dossier
--id* : l'identifiant du dossier.
--project : nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login, une erreur sera affichée.
[terzino@linux tuleap-cli]$ ./tuleap.php docman list --id=110418 --project=myproject
+---------+-----------+----------+--------------+-------------+-------------+-------------+---------+--...
| item_id | parent_id | group_id | title | create_date | update_date | delete_date | user_id | s...
+---------+-----------+----------+--------------+-------------+-------------+-------------+---------+--...
| 110493 | 110418 | 1 | testSoap | 1293189073 | 1293189073 | | 101 | 1...
| 110491 | 110418 | 1 | CLI Document | 1293188351 | 1293188351 | | 101 | 1...
+---------+-----------+----------+--------------+-------------+-------------+-------------+---------+--...
|
Exemple 43. commande list
getRoot: Retourne l'id de la racine du service Documents pour un projet donné
[terzino@linux tuleap-cli]$ ./tuleap.php docman getRoot --project=myproject
+--------+
| Result |
+--------+
| 2 |
+--------+
|
Exemple 44. Commande getRoot
createEmbeddedFile: Ajoute un embedded document au gestionnaire de documents
--parent_id*: identifiant du parent dans lequel le document sera créé
--project*: Nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login, une erreur sera affichée.
--title*: Titre de nouveau document
--description: La description du nouveau document
--status: Le status du nouveau item. Les status possibles sont "none", "draft", "approved", et "rejected"
--content*: Le contenu brut pour le type "embedded_file"
--perm_read: Les Groupes IDs qui vont avoir la permission de lecture, séparés par des virgules
--perm_write: Les Groupes IDs qui vont avoir la permission d'écriture, séparés par des virgules
--perm_manage: Les Groups IDs qui vont avoir la permission de gestion, séparés par des virgules
--perm_none: Les Groups IDs qui n'auront pas de permission, séparés par des virgules(ces groupes ne vont pas hériter les permissions de l'item parent)
--properties: Le fichier qui contient les propriétés qui seront appliquées sur l'item.
--obsolescence_date: Date à laquelle le document sera obsolète (aa-mm-jj|aaaa-mm-jj)
--ordering: place du document dans le dossier parent. Les valeurs possibles sont "begin" et "end"
[terzino@linux tuleap-cli]$ ./tuleap.php docman createEmbeddedFile --project=myproject --parent_id=110418 --title="EmbeddedFile sample" --content="It is just a sample to describe how we add an embedde file to the docman manager"
+--------+
| Result |
+--------+
| 110499 |
+--------+
|
Exemple 45. Commande createEmbeddedFile
Support des gros fichiers: CLI peut ajouter des fichiers supérieurs à 2Go lorsque que la machine cliente (qui exécute CLI) et le serveur sont des machines 64 bits. createFile: Ajoute un fichier au gestionnaire de documents
--parent_id*: identifiant du parent dans lequel le document sera créé
--project*: Nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login, une erreur sera affichée.
--title*: Titre de nouveau document
--description: La description du nouveau document
--status: Le status du nouveau item. Les status possibles sont "none", "draft", "approved", et "rejected"
--content*: L'emplacement du fichier pour le type "file"
--perm_read: Les Groupes IDs qui vont avoir la permission de lecture, séparés par des virgules
--perm_write: Les Groupes IDs qui vont avoir la permission d'écriture, séparés par des virgules
--perm_manage: Les Groups IDs qui vont avoir la permission de gestion, séparés par des virgules
--perm_none: Les Groups IDs qui n'auront pas de permission, séparés par des virgules(ces groupes ne vont pas hériter les permissions de l'item parent)
--properties: Le fichier qui contient les propriétés qui seront appliquées sur l'item.
--obsolescence_date: Date à laquelle le document sera obsolète (aa-mm-jj|aaaa-mm-jj)
--ordering: place du document dans le dossier parent. Les valeurs possibles sont "begin" et "end"
[terzino@linux tuleap-cli]$ ./tuleap.php docman createFile --project=myproject --parent_id=110418 --title="CLi user guide" --content="cli_user_guide.pdf"
Sending file (100%)
File uploaded successfully
+--------+
| Result |
+--------+
| 110498 |
+--------+
|
Exemple 46. Commande createFile
3.4.5 createEmptyDocumentcreateEmptyDocument: Ajoute un document vide au gestionnaire de documents
--parent_id*: identifiant du parent dans lequel le document sera créé
--project*: Nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login, une erreur sera affichée.
--title*: Titre de nouveau document
--description: La description du nouveau document
--status: Le status du nouveau item. Les status possibles sont "none", "draft", "approved", et "rejected"
--perm_read: Les Groupes IDs qui vont avoir la permission de lecture, séparés par des virgules
--perm_write: Les Groupes IDs qui vont avoir la permission d'écriture, séparés par des virgules
--perm_manage: Les Groups IDs qui vont avoir la permission de gestion, séparés par des virgules
--perm_none: Les Groups IDs qui n'auront pas de permission, séparés par des virgules(ces groupes ne vont pas hériter les permissions de l'item parent)
--properties: Le fichier qui contient les propriétés qui seront appliquées sur l'item.
--obsolescence_date: Date à laquelle le document sera obsolète (aa-mm-jj|aaaa-mm-jj)
--ordering: place du document dans le dossier parent. Les valeurs possibles sont "begin" et "end"
[terzino@linux tuleap-cli]$ ./tuleap.php docman createEmptyDocument --project=myproject --parent_id=110418 --title="user guide help"
+--------+
| Result |
+--------+
| 110500 |
+--------+
|
Exemple 47. Commande createEmptyDocument
createLink: Ajoute un lien au gestionnaire de documents
--parent_id*: identifiant du parent dans lequel le document sera créé
--project*: Nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login, une erreur sera affichée.
--title*: Titre de nouveau document
--description: La description du nouveau document
--status: Le status du nouveau item. Les status possibles sont "none", "draft", "approved", et "rejected"
--content*: L'URL pour le type "link"
--perm_read: Les Groupes IDs qui vont avoir la permission de lecture, séparés par des virgules
--perm_write: Les Groupes IDs qui vont avoir la permission d'écriture, séparés par des virgules
--perm_manage: Les Groups IDs qui vont avoir la permission de gestion, séparés par des virgules
--perm_none: Les Groups IDs qui n'auront pas de permission, séparés par des virgules(ces groupes ne vont pas hériter les permissions de l'item parent)
--properties: Le fichier qui contient les propriétés qui seront appliquées sur l'item.
--obsolescence_date: Date à laquelle le document sera obsolète (aa-mm-jj|aaaa-mm-jj)
--ordering: place du document dans le dossier parent. Les valeurs possibles sont "begin" et "end"
[terzino@linux tuleap-cli]$ ./tuleap.php docman createLink --project=myproject --parent_id=110418 --title="user guide link" --content="codendi.org"
+--------+
| Result |
+--------+
| 110501 |
+--------+
|
Exemple 48. createLink command
createWikiPage: Ajoute un wiki document au gestionnnaire de documents
--parent_id*: identifiant du parent dans lequel le document sera créé
--project*: Nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login, une erreur sera affichée.
--title*: Titre de nouveau document
--description: La description du nouveau document
--status: Le status du nouveau item. Les status possibles sont "none", "draft", "approved", et "rejected"
--content*: Le nom de la page wiki pour le type "wiki"
--perm_read: Les Groupes IDs qui vont avoir la permission de lecture, séparés par des virgules
--perm_write: Les Groupes IDs qui vont avoir la permission d'écriture, séparés par des virgules
--perm_manage: Les Groups IDs qui vont avoir la permission de gestion, séparés par des virgules
--perm_none: Les Groups IDs qui n'auront pas de permission, séparés par des virgules(ces groupes ne vont pas hériter les permissions de l'item parent)
--properties: Le fichier qui contient les propriétés qui seront appliquées sur l'item.
--obsolescence_date: Date à laquelle le document sera obsolète (aa-mm-jj|aaaa-mm-jj)
--ordering: place du document dans le dossier parent. Les valeurs possibles sont "begin" et "end"
[terzino@linux tuleap-cli]$ ./tuleap.php docman createWikiPage --project=myproject --parent_id=110418 --title="user guide wiki" --content="user_guide_wiki"
+--------+
| Result |
+--------+
| 110502 |
+--------+
|
Exemple 49. Commande createWikiPage
createFolder : Ajoute un dossier au gestionnaire de documents
--parent_id* : identifiant du parent danslequel le dossier sera créé
--title* : Titre du nouveau dossier
--description : Description du nouveau dossier
--ordering : place du dossier dans le dossier parent. Les valeurs possibles sont "begin" et "end"
--project : nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login, une erreur sera affichée.
[terzino@linux tuleap-cli]$ ./tuleap.php docman createFolder --project=myproject --parent_id=110480 --title="Tech docs folder"
+--------+
| Result |
+--------+
| 110503 |
+--------+
|
Exemple 50. createFolder command
getFile: Download document (Fichier/Embedded fichier)
--id*: L'ID de l'item à télécharger
--output: Nom du fichier
--remote_name: Pour retrouver le nom de fichier depuis le serveur au lieu d'utiliser --output.
--version: Le numéro de la version qu'on veut télécharger. Si la version n'est pas spécifiée, la version sera la courante.
--project : nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login, une erreur sera affichée.
[terzino@linux tuleap-cli]$ ./tuleap.php docman getFile --project=myproject --id=110493 --version_number=1 --output=document_cli.doc
File retrieved successfully.
|
Exemple 51. getFile command
delete : Supprime un item
--id* : identifiant de l'item à supprimer
--project : nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login, une erreur sera affichée.
[terzino@linux tuleap-cli]$ ./tuleap.php docman delete --project=myproject --id=110502
1
|
Exemple 52. commande delete
monitor : Surveiller un item
--id* : identifiant de l'item à surveiller
--project : nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login, une erreur sera affichée.
[terzino@linux tuleap-cli]$ ./tuleap.php docman monitor --project=myproject --id=110501
+--------+
| Result |
+--------+
| 1 |
+--------+
|
Exemple 53. commande monitor
move : Déplace un item
--id* : identifiant de l'item à déplacer
--parent* : identifiant du dossier dans lequel l'item sera déplacé
--project : nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login, une erreur sera affichée.
[terzino@linux tuleap-cli]$ ./tuleap.php docman move --project=myproject --id=110501 --parent=110503
+--------+
| Result |
+--------+
| 1 |
+--------+
|
Exemple 54. move command
Copyright © Xerox Corporation, Codendi Team, 2001-2006. All Rights Reserved |