pi-confluence
v1.1.0
Published
Confluence integration for Pi Coding Agent — search, fetch, and save Confluence pages as Markdown with a TUI config editor
Downloads
206
Maintainers
Readme
pi-confluence
Confluence integration for Pi Coding Agent — search, fetch, and save Confluence pages as Markdown files.
Installation
pi install npm:pi-confluenceFeatures
Tools
| Tool | Description |
|------|-------------|
| confluence_search | Search pages by text or CQL query |
| confluence_fetch | Fetch a page by ID and save as .md |
| confluence_spaces | List available Confluence spaces |
TUI Config Editor
Run /confluence-config inside Pi to interactively configure your credentials with a full TUI overlay — no need to hand-edit JSON files.
HTML → Markdown
Built-in converter handles Confluence-specific markup:
- Structured macros (code blocks, info/note/warning panels)
- Tables, lists, headings, links, images
- Frontmatter with page metadata (ID, space, URL, author, timestamp)
Configuration
Credentials are loaded from (in priority order):
.pi/confluence.json(project-local)~/.pi/agent/confluence.json(global)- Environment variables:
CONFLUENCE_BASE_URL,CONFLUENCE_EMAIL,CONFLUENCE_API_TOKEN
Config format
{
"baseUrl": "https://your-domain.atlassian.net/wiki",
"email": "[email protected]",
"apiToken": "your-api-token",
"outputDir": "./confluence-docs"
}You can reference environment variables with the ENV: prefix:
{
"baseUrl": "https://your-domain.atlassian.net/wiki",
"email": "ENV:CONFLUENCE_EMAIL",
"apiToken": "ENV:CONFLUENCE_API_TOKEN",
"outputDir": "./confluence-docs"
}Get your API token at: https://id.atlassian.com/manage-profile/security/api-tokens
Usage Examples
Once configured, the AI agent can use these tools naturally:
> Search our wiki for deployment guides
→ confluence_search query="deployment guide"
> Fetch the architecture overview page
→ confluence_fetch pageId="12345"
> Download the entire onboarding space
→ confluence_search query="type=page AND space=ONBOARD"
→ confluence_fetch pageId="..." includeChildren=trueLicense
MIT
