GitHub - grandcamel/Confluence-Assistant-Skills: Claude Code skills for automating Confluence Cloud operations via natural language

17
_Skills

88
_Scripts

940
_Tests

CQL
_{Query Support}

🚀 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: Marketplace

claude plugin marketplace add https://github.com/grandcamel/confluence-assistant-skills.git#main
claude plugin install confluence-assistant-skills@confluence-assistant-skills-marketplace --scope user

Option C: 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-as
├── 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
Unit Tests	Comprehensive coverage
E2E Tests	Claude Code integration
Code Style	PEP 8 compliant

Live integration tests are maintained in the confluence-as library.

# Run all tests
pytest -v

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

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

# Live integration tests have been migrated to confluence-as library
# See: https://github.com/grandcamel/confluence-as

🛠️ Troubleshooting

Authentication failed

Verify API token at Atlassian Account Settings
Ensure email matches the token owner
Check URL includes https:// and ends with .atlassian.net

Permission denied

Verify access in Confluence web UI
Some operations require admin permissions
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.

Plugin installation fails

Claude Code strictly validates plugin.json. Common issues:

Unrecognized keys - Remove any custom keys (only standard plugin.json fields allowed)
Wrong marketplace name - Use plugin@marketplace-name format
Cache path - Plugin cache includes .claude-plugin/ directory

# Verify installation
cat ~/.claude/plugins/cache/*/confluence-assistant-skills/*/.claude-plugin/plugin.json

📚 Documentation

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

🤝 Contributing

Fork the repository
Create a feature branch (git checkout -b feature/amazing-feature)
Make your changes with tests
Commit with Conventional Commits format
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

Name		Name	Last commit message	Last commit date
Latest commit History 172 Commits
.claude-plugin		.claude-plugin
.claude		.claude
.github		.github
assets		assets
commands		commands
docker/e2e		docker/e2e
docs/archived		docs/archived
scripts		scripts
skills		skills
tests/e2e		tests/e2e
.gitignore		.gitignore
.pre-commit-config.yaml		.pre-commit-config.yaml
.release-please-manifest.json		.release-please-manifest.json
CHANGELOG.md		CHANGELOG.md
CLAUDE.md		CLAUDE.md
LICENSE		LICENSE
README.md		README.md
VERSION		VERSION
conftest.py		conftest.py
pyproject.toml		pyproject.toml
pytest.ini		pytest.ini
release-please-config.json		release-please-config.json
requirements-e2e.txt		requirements-e2e.txt

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

🚀 Stop clicking through Confluence. Start talking to it.

😤 Without Assistant Skills

🎯 With Assistant Skills

⚡ Quick Start

1️⃣ Install

2️⃣ Configure

3️⃣ Install CLI

4️⃣ Use

🔧 Setup (Assistant Skills)

Environment Variables

🎯 What You Can Do

📦 Available Skills

🔍 CQL Query Power

Find Content

Export Results

👥 Who Is This For?

🏗️ Architecture

🔐 Configuration

Environment Variables

✅ Quality & Testing

🛠️ Troubleshooting

📚 Documentation

🤝 Contributing

📄 License

About

Uh oh!

Releases 3

Packages

Uh oh!

Contributors

Uh oh!

Languages

Folders and files

Latest commit

History

Repository files navigation

🚀 Stop clicking through Confluence. Start talking to it.

😤 Without Assistant Skills

🎯 With Assistant Skills

⚡ Quick Start

1️⃣ Install

2️⃣ Configure

3️⃣ Install CLI

4️⃣ Use

🔧 Setup (Assistant Skills)

Environment Variables

🎯 What You Can Do

📦 Available Skills

🔍 CQL Query Power

Find Content

Export Results

👥 Who Is This For?

🏗️ Architecture

🔐 Configuration

Environment Variables

✅ Quality & Testing

🛠️ Troubleshooting

📚 Documentation

🤝 Contributing

📄 License

About

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases 3

Packages 0

Uh oh!

Contributors

Uh oh!

Languages

Packages