Get Started
On this page
After you have installed the add-on using UPM
Create a new page
Use Insert -> Markup
Copy the following markup to the dialog, modify to your Confluence environment, and then hit enter
Press Preview to see the results (avoid saving the page, see next steps below)
Wiki markup example
{cli:product=confluence|server=https://<your Confluence server>|user=<your Confluence user id>|password=<your Confluence user password>}
--action getServerInfo
{cli}The result should look similar to this
Output
Confluence version: 5.5.0, build: 5609, url: https://bobswift.atlassian.net/wikiNext steps
We recommend setting up a profile in your add-on configuration to store your server, user, and password information for security and re-use.
Go to UPM
Find the CLI add-on
Press Configure
Add a profile entry with the details of your server environment - see the following picture
Now use {cli:profile=my-profile-entry} instead in the steps above (or use the Macro browser to modify your original example)
Profiles
Security
The above section explains how to avoid putting passwords on pages. However, the configured profile can be used by anyone that can edit content on your site. If all you users are trusted, then you are good. However, in most cases you will want to restrict access to a group of users that are trusted to use this capability. This is accomplished by using Macro Security for Confluence and configuring access to the macro and perhaps to individual profiles. Go to the documentation for Macro Security for more information.
Need support? Create a request with our support team.
Copyright © 2005 - 2025 Appfire | All rights reserved.
