Component Libraries • Project Templates
Docs • Install • Tutorials • Developer Guides • Contribute • Blog • Discord

Xircuits Component Library for Confluence! Seamlessly manage and interact with Confluence content.

---

Xircuits Component Library for Confluence

This library enables seamless integration with Atlassian Confluence in Xircuits workflows. With it, you can authenticate, retrieve pages, search content, create new pages, and manage Confluence data efficiently.

Table of Contents

• Prerequisites
• Main Xircuits Components
• Try the Examples
• Installation

Prerequisites

Before you begin, make sure you have the following:

1. Python 3.9+.
2. Xircuits.
3. A Confluence instance with API access.
4. Confluence authentication credentials (username and password) or environment variables (CONFLUENCE_URL, CONFLUENCE_USER, CONFLUENCE_PASSWORD).

Main Xircuits Components

ConfluenceAuthorize Component:

Initializes a Confluence client with the provided credentials or from environment variables.

ConfluenceGetPage Component:

Retrieves a specific page from Confluence using its page ID.

ConfluenceSearchPages Component:

Searches for pages in Confluence based on a query string.

ConfluenceSearchByQueryAndTag Component:

Searches for pages using both a query and specified tags. Supports filtering by all tags or any tag.

ConfluenceCreatePage Component:

Creates a new page in a specified Confluence space with a given title and content.

Installation

To use this component library, ensure that you have an existing Xircuits setup. You can then install the Confluence library using the component library interface, or through the CLI using:

xircuits install confluence

You can also install it manually by cloning the repository:

# base Xircuits directory

git clone https://github.com/XpressAI/xai-confluence xai_components/xai_confluence
pip install -r xai_components/xai_confluence/requirements.txt