Chapter 3. Module functions and parameters

Table of Contents

3.1. Core functions

3.1.1. login
3.1.2. logout
3.1.3. myprojects

3.2. Tracker functions

3.2.1. trackerlist
3.2.2. trackers
3.2.3. tracker
3.2.4. list
3.2.5. reportlist
3.2.6. reports
3.2.7. add
3.2.8. update
3.2.9. comments
3.2.10. addComment
3.2.11. updateComment
3.2.12. deleteComment
3.2.13. CCList
3.2.14. addCC
3.2.15. deleteCC
3.2.16. dependencies
3.2.17. inverseDependencies
3.2.18. addDependencies
3.2.19. deleteDependency
3.2.20. artifactHistory
3.2.21. attachedFiles
3.2.22. attachedFile
3.2.23. addAttachedFile
3.2.24. deleteAttachedFile

3.3. File Release System functions

3.3.1. getPackages
3.3.2. addPackage
3.3.3. getReleases
3.3.4. addRelease
3.3.5. getFiles
3.3.6. addFile
3.3.7. getFile
3.3.8. getUploadedFiles
3.3.9. deleteFile
3.3.10. getFileInfo
3.3.11. deleteEmptyPackage
3.3.12. deleteAllEmptyPackages
3.3.13. deleteEmptyRelease
3.3.14. deleteAllEmptyReleases

3.4. Document Manager functions

3.4.1. list
3.4.2. getRoot
3.4.3. createEmbeddedFile
3.4.4. createFile
3.4.5. createEmptyDocument
3.4.6. createLink
3.4.7. createWikiPage
3.4.8. createFolder
3.4.9. getFile
3.4.10. delete
3.4.11. monitor
3.4.12. move

3.1 Core functions

These functions do not act over a specific module. They are the following:

3.1.1 login

--username: Specifies the name of the user you'll be working with. The username is the one you usually use in the Tuleap login page.
--password: Specifies the password to login with. If none is provided, you will be asked for one interactively.
--host: Specifies the host where your Tuleap server (as well as the soap server) is installed (optional).
--proxy: Specifies the proxy if needed. Use is --host=proxy_host:proxy_port
--project: UNIX name of the project you plan working on. If you don't specify this, any future function call will require you to specify the project in which the function will be applied.

[ounis@linux tuleap-cli]$ ./tuleap.php login --username=john --password=johnpass --project=myproject
+---------+----------------------------------+
| user_id |           session_hash           |
+---------+----------------------------------+
| 103     | de6bb9f64e0ad45a0a0209f112f774f7 |
+---------+----------------------------------+
Logged in.
(OR)
[ounis@linux tuleap-cli]$ ./tuleap.php login --username=marc --project=myproject
Password:
+---------+----------------------------------+
| user_id |           session_hash           |
+---------+----------------------------------+
| 103     | de6bb9f64e0ad45a0a0209f112f774f7 |
+---------+----------------------------------+
Logged in.

Example 2. login command

3.1.2 logout

logout: End a session. This removes all the information of the session from your computer.

[mnazaria@linux tuleap-cli]$ ./tuleap.php logout
Session terminated.

Example 3. logout command

3.1.3 myprojects

myprojects : Display the list of the projects the user is member of.

[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    |
+----------+------------+-----------------+-------------+

Example 4. myprojects command