Reference
Explained
Below you will find a complete list of the Actions and Parameters available in the ACLI for this client.
Actions
These are the keywords that tell the CLI what action to take. The listed actions correspond to everything you can do via the screens on the app when you point, click, and type text into fields.
You see a pattern to the beginning or prefix that is an action verb such as: add, copy, export, get, modify, move, remove, run, store, update, and more depending on the app.
The ending or suffix to the action name is the noun or object of the verb such as attachment, comment, label, permission, user, and more depending on the app.
For example, the action addComment adds a comment to an item in the app.
Each app has its own features and set of actions, in addition to the actions shared with other apps.
Parameters
Parameters tell the CLI the specific details needed to perform an action. Some actions work without any additional details, but most require one or more parameters and accept additional optional parameters to perform the task.
The CLI requires at least one special parameter named action that tells what action to perform, without the action parameter, CLI displays help with some example actions. Parameters do not have prefixes like actions and are often specific to the app for the action.
For example, the action getServerInfo requires details about the app or server from where the information is retrieved. To obtain the required information, the server parameter is used.
The getServerInfo action also accepts optional parameters such as outputFormat, dateFormat, file, append, and encoding.
Example
An action and its parameters put together unlock the power to get things done with your apps.
The example shows how to retrieve information from an example Jira Cloud application with anonymous access in a multi-line format:
acli --action getServerInfo --server https://examplegear.atlassian.net --outputFormat 2Action output:
Server info
Product . . . . . . . . . . . : Jira
Hosting . . . . . . . . . . . : cloud
Version . . . . . . . . . . . : 1001.0.0-SNAPSHOT
Base URL . . . . . . . . . . : https://examplegear.atlassian.net
Title . . . . . . . . . . . . : Appfire Example Gear Jira
Build . . . . . . . . . . . . : 100221
Build date . . . . . . . . . : 2023/04/10 8:02
License information . . . . . : Not available. Reason: Administrator access is required to get license information.
Client . . . . . . . . . . . : jira
User . . . . . . . . . . . . : anonymous
Response time (milliseconds) : 638On this page
Related pages
Generating content properties report...
| --path |
|
| Source path. | |
| --parent |
|
| Confluence page title for a parent page. | |
| --outputFormat |
|
| Specify output format for list actions. Output format determines what columns are retrieved for the list. More columns usually take longer to retrieve. | |
| --quiet |
|
| Limit some output messages. Optional for all actions. | |
| --driver |
|
| JDBC driver class or predefined value: postgresql, mysql, mssql, oracle, db2, or db2400. Normally automatically determined for many databases based on url parameter. | |
| --dbJar |
|
| ACLI has built-in support for Postgres and by default loads database drivers found in the ACLI installation's lib/jdbc directory. Otherwise you can specify a specific file or URL reference for the database driver jar. Examples /jdbcDrivers/postgresql-42.4.2.jar or https://jdbc.postgresql.org/download/postgresql-42.4.2.jar. | |
| --action | a |
| Requested operation to perform. Valid actions are listed separately. | |
| --requestType |
|
| Type of a render request like GET, POST, PUT, DELETE, PATCH, HEAD. | |
| --workspace |
|
| Workspace | |
| --comment |
|
| Comment text. | |
| --requestParameters |
|
| Additional url request parameters append to the url for the renderRequest action. Use the data parameter for request post data for POST and PUT requests. | |
| --clearFileBeforeAppend |
|
| For run actions, this option will automatically clear an existing file on the first append requested. | |
| --type |
|
| Deployment environment type. | |
| --dateFormat2 |
|
| Alternate format string for dates in Java SimpleDateFormat. Use specific (may be ignored), but normally used for date only fields to avoid longer dateFormat based output. Some uses default to yyyy-MM-dd. | |
| --connectionTimeout |
|
| Allow overriding environment settings for connect and read timeouts on URL connections. In milliseconds, 0 means infinite. | |
| --description |
|
| Description. | |
| --append |
|
| For some actions using the file parameter, append will append output to an existing file. | |
| --targetPassword |
|
| Confluence user password. Defaults to password. | |
| --verbose | v |
| Requests verbose output to help with problem determination. Optional for all actions. | |
| --user | u |
| User name for remote access. Cloud users are identified by email address. | |
| --title |
|
| Source title. | |
| --revision |
|
| Repository revision id like a commit id, branch, tag, or special value like HEAD (for Git). | |
| --owner |
|
| Repository owner name. | |
| --name |
|
| Name of an item or entity. | |
| --sql |
|
| SQL select statement used to generate a run script. | |
| --query |
|
| Query to filter list by. See https://developer.atlassian.com/cloud/bitbucket/rest/intro/#querying. | |
| --repository |
|
| Repository name. | |
| --url |
|
| Action specific setting. URL or partial URL for renderRequest. Database access URL for SQL related actions. URL for application link related actions. | |
| --encoding |
|
| Character encoding (character set) for text based file content - must be an encoding supported by your Java platform. | |
| --help |
|
| Shows a help message. |