User's Guide


Add-on Example

{run:titleRun=Add labels|replace=space:zcli,labels:test}
--action runFromSql --continue
select '--action addLabels --labels "$labels" --space $space --title "' || title || '"' from content where spaceid in (select spaceid from spaces where spacekey = '$space')

CLI Documentation Links

Actions for various remote server instances

Any server instance supported by the Atlassian CLI can be accessed for running actions depending on having valid user credentials for the actions requested. This is the same as running the actions from a command line.

Confluence user id

The logged in Confluence user's password is NOT available for CLI actions. A valid password is required either provided directly or via profile support.


Profiles allow administrators to save commonly used parameter sets for easy maintenance. This is especially important for accessing servers including server addresses, user ids, and passwords. Furthermore, by putting user ids and passwords in profiles, the password cannot be seen by normal users, only administrators that have access to add-on configuration can view the configuration.

User's should consult with their Confluence administrator on definition and usage. Administrators should view Profiles and Security for more information.