feat: add read-only mode for safe AI agent usage

[pchuri]

Pull Request Template

Description

Add profile-level read-only mode that blocks all write operations at the CLI level, designed for safe AI agent usage. Resolves #73.

When readOnly is enabled (via profile config or CONFLUENCE_READ_ONLY=true env var), the following 13 write commands are blocked: create, create-child, update, move, delete, edit, attachment-upload, attachment-delete, property-set, property-delete, comment, comment-delete, copy-tree.

Type of Change

• New feature (non-breaking change which adds functionality)
• Documentation update

Testing

• Tests pass locally with my changes
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes

Checklist

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• Any dependent changes have been merged and published in downstream modules

Changes

lib/config.js

• getConfig() returns readOnly field from profile or CONFLUENCE_READ_ONLY env var
• saveConfig() persists readOnly flag
• listProfiles() includes readOnly status
• initConfig() accepts readOnly option

bin/confluence.js

• assertWritable(config) guard function — exits with code 1 when readOnly is true
• Guard applied to all 13 write commands
• --read-only option on init and profile add commands
• [read-only] badge in profile list output

tests/read-only.test.js (new)

• Env var behavior (default false, true, false override)
• Config file readOnly field with mocked fs
• Env var overrides config file
• assertWritable() function behavior
• listProfiles() includes readOnly flag

README.md / SKILL.md

• Read-only mode section with usage examples
• --read-only flag documented for init and profile add
• CONFLUENCE_READ_ONLY env var documented
• Commands table updated

[Copilot]

Pull request overview

Adds a profile-level read-only mode to prevent accidental Confluence writes (particularly for AI agent usage), enforced at the CLI command layer and configurable via profile config or CONFLUENCE_READ_ONLY.

Changes:

• Add readOnly support to config loading/saving and profile listing.
• Add an assertWritable() guard and apply it to all write commands; add --read-only to init and profile add.
• Add read-only mode documentation and a new Jest test suite covering the behavior.

Reviewed changes

Copilot reviewed 4 out of 5 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
lib/config.js	Reads CONFLUENCE_READ_ONLY, persists readOnly in profiles, and exposes it via getConfig() / listProfiles().
bin/confluence.js	Introduces assertWritable(config) and applies it to write commands; adds --read-only to profile creation flows and shows a [read-only] badge.
tests/read-only.test.js	Adds tests for env/config precedence, assertWritable(), and listProfiles() readOnly field.
README.md	Documents read-only mode, env var, flags, and command table updates.
.claude/skills/confluence/SKILL.md	Updates the skill doc to include read-only mode guidance and error pattern.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[github-actions]

🎉 This PR is included in version 1.27.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀