Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Current »


  • Unzip the distribution package and put the enclosed directory in a convenient location
  • Ensure Remote API is enabled in your Confluence installation
    • You need to be an administrator
    • Go to General Administration under Remote API
    • Setting should be YES
  • It is recommended that you open the confluence.bat or file with an editor and customize it for your environment by adding serveruser, and password parameters. Follow the example in the comments and make sure you do not remove the %* at the end of the line.


  • On a command line, cd to the directory where you installed the client
  • On Windows
    • Run confluence
  • On Linux, Mac, or Unix
    • Run ./
  • On any system supporting Java
    • Run java -jar lib/confluence-cli-3.x.x.jar
  • This will show help text for the command line interface client
  • The client defaults to use a user of automation. Either add this user with all the authorities required to do the actions you want or specify a different user parameter


confluence --action getServerInfo
Confluence version: 5.2.3, build: 4394, url:
  • No labels