@knpkv/confluence-to-markdown

Warning This package is experimental and in early development. Code is primarily AI-generated and not yet publicly published. For preview, use snapshot releases.

Sync Confluence Cloud pages to local GitHub Flavored Markdown files.

Installation

npm install @knpkv/confluence-to-markdown effect

CLI Usage

# Initialize configuration
confluence init --root-page-id 123456 --base-url https://yoursite.atlassian.net

# Pull pages from Confluence
confluence pull

# Push local changes to Confluence
confluence push

# Bidirectional sync
confluence sync

# Check sync status
confluence status

Configuration

Create .confluence.json in your project root:

{
  "rootPageId": "123456",
  "baseUrl": "https://yoursite.atlassian.net",
  "spaceKey": "DEV",
  "docsPath": ".docs/confluence"
}

Environment Variables

export CONFLUENCE_API_KEY=your-api-token
export [email protected]

Known Limitations

• Page creation: Creating new pages from local markdown is not yet implemented
• Conflict detection: Bidirectional sync does not detect conflicts (last write wins)
• Attachments: Image and file attachments are not synced
• Comments: Page comments are not preserved

License

MIT