csync

A command line program for synchronizing Confluence pages with a local file system.

• Future plans to integrate with the parser that powers mark so we can pull and push to confluence with mark's extended markdown format.
  • Maybe a custom Markdown Flavor based on ADF.
  • See the ADF Playground for a better idea of why this might be useful.

Usage

csync --help

Features

• Pull Confluence pages (and their children) to a local filesystem path.

• Push local changes back to Confluence, creating or updating pages as needed.

• Local confluence representation contains version metadata, attachments

• Support for attachments, allowing files to be downloaded and uploaded along with page content.

• Edit metadata (title, version, etc...) locally and have page metadata updated on the remote upon push.

• Better support for pushing to spaces with no matching page id (i.e. creating a new page) verses updating a space with an existing matching page id (i.e. updating a page).

# if creating a new page it will preserve the version history and owner
csync push --preserve ... 

# if an existing page is found that is being updated, overwrite the remote metadata in favor of the local metadata. If there's no local metadata, remote metadata is "reset" 
csync push --overwrite ... 

• Better support for true sync features and edge cases.

# Pull only pages that have changed since the last sync
csync pull --skip-unchanged https://your-instance.atlassian.net/wiki/spaces/SPACE/pages/123456 ./local-pages

# Push only pages that have changed locally
csync push --skip-unchanged ./local-pages https://your-instance.atlassian.net/wiki/spaces/SPACE/pages/123456

# Specify a custom configuration file
csync pull --config /path/to/config.json https://your-instance.atlassian.net/wiki/spaces/SPACE/pages/123456 ./local-pages

• Parallelism for larger migrations

• Better dry run visualization

Installation from Source

git clone https://github.com/ocasazza/csync.git
cd csync
pip install -e .

Configuration

CSync can be configured using environment variables, a .env file, or a configuration file:

.env File

Create a .env file in your current directory:

CONFLUENCE_URL=https://your-instance.atlassian.net
CONFLUENCE_USERNAME=your-email@example.com
ATLASSIAN_TOKEN=your-api-token