Skip to end of banner
Go to start of banner

How to export pages with specific labels to PDF files using Confluence CLI

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 3 Current »

This article explains how to export pages from a Confluence space having specific labels to PDF files using Confluence CLI.

Instructions

To export pages having a specific label, use:

--action runFromPageList --labels "mylabels" --common " --action exportPage --id "@pageId@" --exportType "PDF" --file "@pageId@.pdf""


To export pages including subpages that have a specific label, use:

--action runFromPageList --labels "mylabels" --common " --action exportSpace --space "@space@" --title \""@title@\"" --exportType "PDF" --file "@pageId@.pdf""

The parameters and actions used in the above command are:

  • runFromPageList runs actions for each page from a page list.

  • exportSpace exports a space to a file.

  • exportPage export a page to a file.

  • --space, --title, and --id act as substitution variables.

  • --file refers to the path and the name of the file containing the resultant output.

  • --exportType indicates the type of pages the export should be in.

  • --labels pass the required label name. In this case, “mylabels” is passed as the label value.

  • No labels