Skip to main content

Claude Code plugin providing skills (documentation) for Confluence automation.

Project description

Confluence Assistant Skills



14
Skills
88
Scripts
940
Tests
CQL
Query Support

Release PyPI License Python Confluence


๐Ÿš€ Stop clicking through Confluence. Start talking to it.

Confluence Assistant Skills brings the power of natural language automation to Confluence Cloud.
Ask Claude to create pages, search content, manage permissions, and more โ€” all without leaving your terminal.


You: "Find all pages labeled 'api-docs' modified this week and export to CSV"

Claude: Found 23 pages matching your criteria.
        โœ“ Exported to api-docs-report.csv

Get Started ยท View Skills ยท Documentation ยท Contributing




๐Ÿ˜ค Without Assistant Skills

1. Open browser
2. Navigate to Confluence
3. Click through menus
4. Find the right space
5. Create page manually
6. Copy-paste content
7. Format everything
8. Add labels one by one
9. Set permissions
10. Repeat for next page...

Time: 15+ minutes per page

๐ŸŽฏ With Assistant Skills

You: "Create a page called 'Q4 Planning'
      in the DOCS space with the content
      from my notes.md file, label it
      'planning' and 'q4-2024'"

Claude: โœ“ Created page "Q4 Planning"
        โœ“ Added 2 labels
        โœ“ Page ID: 12345

Time: 10 seconds




โšก Quick Start

1๏ธโƒฃ Install

Option A: Claude Code Plugin (recommended)

/plugin grandcamel/Confluence-Assistant-Skills

Option B: Manual

git clone https://github.com/grandcamel/Confluence-Assistant-Skills.git
pip install -r requirements.txt

2๏ธโƒฃ Configure

export CONFLUENCE_SITE_URL="https://your-site.atlassian.net"
export CONFLUENCE_EMAIL="you@company.com"
export CONFLUENCE_API_TOKEN="your-api-token"

Get your API token from Atlassian Account Settings

3๏ธโƒฃ Install CLI

pip install -e .

# Verify installation
confluence --version
confluence space list --limit 1

4๏ธโƒฃ Use

# CLI commands
confluence page get 12345
confluence search cql "space = DOCS"
confluence label add 12345 approved

# Or ask Claude naturally:
"Create a page titled 'Meeting Notes' in the DOCS space"
"Search for pages about API documentation"
"Add label 'approved' to page 12345"



๐Ÿ”ง Setup (Assistant Skills)

If you're using this as part of the Assistant Skills ecosystem, run the setup wizard after installing:

/assistant-skills-setup

This configures:

  • Shared Python venv at ~/.assistant-skills-venv/
  • Required dependencies from requirements.txt
  • Environment variables (prompts you to set: CONFLUENCE_SITE_URL, CONFLUENCE_EMAIL, CONFLUENCE_API_TOKEN)
  • claude-as shell function for running Claude with dependencies

After setup, use claude-as instead of claude:

claude-as  # Runs Claude with Assistant Skills venv activated

Environment Variables

Variable Required Description
CONFLUENCE_SITE_URL Yes Confluence Cloud site URL (e.g., https://your-site.atlassian.net)
CONFLUENCE_EMAIL Yes Atlassian account email for API authentication
CONFLUENCE_API_TOKEN Yes API token from Atlassian Account Settings



๐ŸŽฏ What You Can Do

flowchart LR
    subgraph Input["๐Ÿ’ฌ Natural Language"]
        A["Create a page about..."]
        B["Find all pages with..."]
        C["Update permissions for..."]
    end

    subgraph Skills["๐Ÿ”ง 14 Skills"]
        D[Pages]
        E[Search]
        F[Permissions]
        G[Labels]
        H[Comments]
        I[+ 9 more]
    end

    subgraph Output["โœ… Results"]
        J["Pages created"]
        K["Content found"]
        L["Settings updated"]
    end

    A --> D --> J
    B --> E --> K
    C --> F --> L

    style Input fill:#0052CC,color:#fff
    style Skills fill:#36B37E,color:#fff
    style Output fill:#00C7E6,color:#000



๐Ÿ“ฆ Available Skills

Skill Purpose Example Commands
confluence-page Create, read, update, delete pages create_page, get_page, update_page, copy_page, move_page
confluence-space Manage spaces list_spaces, create_space, get_space, delete_space
confluence-search CQL queries & export cql_search, search_content, export_results, cql_validate
confluence-comment Page comments add_comment, get_comments, update_comment, delete_comment
confluence-attachment File attachments upload_attachment, download_attachment, list_attachments
confluence-label Content labeling add_label, remove_label, get_labels
confluence-template Page templates list_templates, get_template, create_from_template
confluence-property Content properties get_properties, set_property, delete_property
confluence-permission Access control get_space_permissions, add_space_permission
confluence-analytics View statistics get_page_views
confluence-watch Content watching watch_page, unwatch_page
confluence-hierarchy Page tree navigation get_ancestors, get_children, get_descendants
confluence-jira JIRA integration embed_jira_issues, get_linked_issues
confluence-assistant Central hub Routes to specialized skills



๐Ÿ” CQL Query Power

Full Confluence Query Language support with validation, suggestions, and export.

Find Content

-- Pages in a space
space = "DOCS" AND type = page

-- By label
label = "approved" AND label = "api"

-- Text search
text ~ "API documentation"

-- Recent changes
lastModified >= startOfWeek()

Export Results

# Export to CSV
confluence search export "label = 'release-notes'" \
  --format csv \
  --output-file releases.csv

# Export to JSON
confluence search export "space = 'DOCS'" \
  --format json



๐Ÿ‘ฅ Who Is This For?

๐Ÿ“ Technical Writers โ€” Automate documentation workflows
  • Bulk create pages from templates
  • Search and update outdated content
  • Export content for review
  • Manage labels across hundreds of pages
# Find all pages needing review
confluence search cql "label = 'needs-review' AND lastModified < startOfMonth(-3)"
๐Ÿ› ๏ธ DevOps Engineers โ€” Integrate Confluence into CI/CD
  • Auto-generate release notes
  • Update runbooks from code
  • Sync documentation with deployments
  • Create incident pages automatically
# Create release notes page
confluence page create RELEASES "v2.5.0" --file CHANGELOG.md
๐Ÿ‘” Project Managers โ€” Streamline project documentation
  • Create project spaces from templates
  • Generate status reports
  • Track page analytics
  • Manage team permissions
# Get page view statistics
confluence analytics views 12345 --output json
๐Ÿ”’ IT Administrators โ€” Manage Confluence at scale
  • Audit space permissions
  • Bulk update settings
  • Export content for compliance
  • Automate user provisioning
# List all space permissions
confluence permission space DOCS --output json



๐Ÿ—๏ธ Architecture

# Root configuration
pytest.ini                    # Test paths, markers, import mode
conftest.py                   # Shared fixtures and pytest hooks

.claude/skills/
โ”œโ”€โ”€ confluence-assistant/     # Hub skill - routes requests
โ”œโ”€โ”€ confluence-page/          # Page CRUD operations
โ”œโ”€โ”€ confluence-space/         # Space management
โ”œโ”€โ”€ confluence-search/        # CQL queries & export
โ”œโ”€โ”€ confluence-comment/       # Comments
โ”œโ”€โ”€ confluence-attachment/    # File attachments
โ”œโ”€โ”€ confluence-label/         # Labels
โ”œโ”€โ”€ confluence-template/      # Templates
โ”œโ”€โ”€ confluence-property/      # Content properties
โ”œโ”€โ”€ confluence-permission/    # Permissions
โ”œโ”€โ”€ confluence-analytics/     # Analytics
โ”œโ”€โ”€ confluence-watch/         # Watching
โ”œโ”€โ”€ confluence-hierarchy/     # Page tree
โ”œโ”€โ”€ confluence-jira/          # JIRA integration
โ””โ”€โ”€ shared/
    โ”œโ”€โ”€ config/               # Configuration schema
    โ””โ”€โ”€ tests/                # Shared test fixtures

# Shared library (PyPI package)
confluence-assistant-skills-lib
โ”œโ”€โ”€ confluence_client.py      # HTTP client with retry
โ”œโ”€โ”€ config_manager.py         # Configuration management
โ”œโ”€โ”€ error_handler.py          # Exception handling
โ”œโ”€โ”€ validators.py             # Input validation
โ””โ”€โ”€ formatters.py             # Output formatting



๐Ÿ” Configuration

Environment Variables

All configuration is done through environment variables:

export CONFLUENCE_SITE_URL="https://your-site.atlassian.net"
export CONFLUENCE_EMAIL="you@company.com"
export CONFLUENCE_API_TOKEN="your-api-token"
Variable Required Description
CONFLUENCE_SITE_URL Yes Confluence Cloud site URL
CONFLUENCE_EMAIL Yes Atlassian account email
CONFLUENCE_API_TOKEN Yes API token from Atlassian Account Settings



โœ… Quality & Testing

Metric Value
Total Tests 940
Unit Tests Comprehensive coverage
Live Integration Tests 64 test files
Code Style PEP 8 compliant
# Run all tests
pytest -v

# Run unit tests only (skip live integration)
pytest .claude/skills/ -v --ignore-glob="**/live_integration/*"

# Run with coverage
pytest --cov=confluence_assistant_skills_lib --cov-report=html

# Run live integration tests
pytest .claude/skills/*/tests/live_integration/ --live -v

# Run E2E tests (requires ANTHROPIC_API_KEY)
./scripts/run-e2e-tests.sh           # Docker
./scripts/run-e2e-tests.sh --local   # Local



๐Ÿ› ๏ธ Troubleshooting

Authentication failed
  1. Verify API token at Atlassian Account Settings
  2. Ensure email matches the token owner
  3. Check URL includes https:// and ends with .atlassian.net
Permission denied
  1. Verify access in Confluence web UI
  2. Some operations require admin permissions
  3. Check if content is restricted
CQL syntax error
# Validate your query
confluence search validate "your query"

Check quotes are balanced and field names are valid.




๐Ÿ“š Documentation

Resource Description
CLAUDE.md Developer guide, patterns, API reference
CHANGELOG.md Release history
Confluence API Docs Official API reference



๐Ÿค Contributing

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Make your changes with tests
  4. Commit with Conventional Commits format
  5. Push and submit a pull request
# Commit format
feat(page): add copy page functionality
fix(search): handle empty CQL results
docs: update README
test(space): add integration tests



๐Ÿ“„ License

MIT License โ€” see LICENSE for details.




โฌ† Back to Top


Made with โค๏ธ for the Confluence community


GitHub stars

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

confluence_assistant_skills_plugin-2.0.0.tar.gz (9.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file confluence_assistant_skills_plugin-2.0.0.tar.gz.

File metadata

File hashes

Hashes for confluence_assistant_skills_plugin-2.0.0.tar.gz
Algorithm Hash digest
SHA256 181e788be2d94a59a05cb214df4369a28ca56591521b2dab196bb61f093e2d5a
MD5 82084f745c10cf4ab6da4f33854bcb5b
BLAKE2b-256 76619fa63b8680f3e1544d5d55f79e678aa6dd4dd3cc1376b28c3b87d0e84b08

See more details on using hashes here.

File details

Details for the file confluence_assistant_skills_plugin-2.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for confluence_assistant_skills_plugin-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0afc9bdc1b8ab1a269317df1c0eb898f5870879f1891027a2d031193f8092efc
MD5 b0bf3a0cf27e541587a7dfc17add651b
BLAKE2b-256 b7e579d3c208a0f4b03fc81e529ccb2914bc2e368ca60287c02f4dcb17bd081f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page