confluence-cli 1.19.0 → 1.21.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.claude/skills/confluence/SKILL.md +610 -0
- package/README.md +20 -5
- package/bin/confluence.js +95 -14
- package/lib/config.js +17 -17
- package/lib/confluence-client.js +1 -1
- package/package.json +7 -2
- package/.eslintrc.js +0 -23
- package/.github/ISSUE_TEMPLATE/bug_report.md +0 -34
- package/.github/ISSUE_TEMPLATE/feature_request.md +0 -26
- package/.github/ISSUE_TEMPLATE/feedback.md +0 -37
- package/.github/pull_request_template.md +0 -31
- package/.github/workflows/ci.yml +0 -68
- package/.releaserc +0 -17
- package/CHANGELOG.md +0 -267
- package/CONTRIBUTING.md +0 -246
- package/docs/PROMOTION.md +0 -63
- package/eslint.config.js +0 -33
- package/examples/copy-tree-example.sh +0 -117
- package/examples/create-child-page-example.sh +0 -67
- package/examples/demo-page-management.sh +0 -68
- package/examples/demo.sh +0 -43
- package/examples/sample-page.md +0 -30
- package/jest.config.js +0 -13
- package/llms.txt +0 -46
- package/tests/confluence-client.test.js +0 -1003
package/CHANGELOG.md
DELETED
|
@@ -1,267 +0,0 @@
|
|
|
1
|
-
# [1.19.0](https://github.com/pchuri/confluence-cli/compare/v1.18.0...v1.19.0) (2026-02-20)
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
### Features
|
|
5
|
-
|
|
6
|
-
* add --cql flag to search command for raw CQL queries ([#40](https://github.com/pchuri/confluence-cli/issues/40)) ([311f5a9](https://github.com/pchuri/confluence-cli/commit/311f5a98bfd175c6b7902c55b4dd0687b2a0d8c0)), closes [#39](https://github.com/pchuri/confluence-cli/issues/39)
|
|
7
|
-
|
|
8
|
-
# [1.18.0](https://github.com/pchuri/confluence-cli/compare/v1.17.0...v1.18.0) (2026-02-15)
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
### Features
|
|
12
|
-
|
|
13
|
-
* add content property commands (list, get, set, delete) ([#38](https://github.com/pchuri/confluence-cli/issues/38)) ([506515d](https://github.com/pchuri/confluence-cli/commit/506515dd0c271e5385ede3a49225d4b4707f225d)), closes [#37](https://github.com/pchuri/confluence-cli/issues/37)
|
|
14
|
-
|
|
15
|
-
# [1.17.0](https://github.com/pchuri/confluence-cli/compare/v1.16.0...v1.17.0) (2026-02-13)
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
### Features
|
|
19
|
-
|
|
20
|
-
* add attachment upload and delete commands ([#36](https://github.com/pchuri/confluence-cli/issues/36)) ([ed62bb4](https://github.com/pchuri/confluence-cli/commit/ed62bb45468566c128f066016615048e31ed1775))
|
|
21
|
-
|
|
22
|
-
# [1.16.0](https://github.com/pchuri/confluence-cli/compare/v1.15.1...v1.16.0) (2026-02-13)
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
### Features
|
|
26
|
-
|
|
27
|
-
* Add move command to relocate pages ([#32](https://github.com/pchuri/confluence-cli/issues/32)) ([a37f9b8](https://github.com/pchuri/confluence-cli/commit/a37f9b83174ef08a6517fe279dcce1b39fc1fb1a))
|
|
28
|
-
|
|
29
|
-
## [1.15.1](https://github.com/pchuri/confluence-cli/compare/v1.15.0...v1.15.1) (2026-02-12)
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
### Bug Fixes
|
|
33
|
-
|
|
34
|
-
* parse page ID from pretty URLs ([#34](https://github.com/pchuri/confluence-cli/issues/34)) ([6f22cd5](https://github.com/pchuri/confluence-cli/commit/6f22cd5424aec11a330a3cc7faf9cbeccb943168))
|
|
35
|
-
|
|
36
|
-
# [1.15.0](https://github.com/pchuri/confluence-cli/compare/v1.14.0...v1.15.0) (2026-02-06)
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
### Features
|
|
40
|
-
|
|
41
|
-
* Add CLI flags to confluence init for non-interactive setup ([#30](https://github.com/pchuri/confluence-cli/issues/30)) ([09b6b85](https://github.com/pchuri/confluence-cli/commit/09b6b85a243da5ab86eb61a1a2376a64ce6979c7))
|
|
42
|
-
|
|
43
|
-
# [1.14.0](https://github.com/pchuri/confluence-cli/compare/v1.13.0...v1.14.0) (2026-02-03)
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
### Features
|
|
47
|
-
|
|
48
|
-
* add comments support to CLI ([d40de55](https://github.com/pchuri/confluence-cli/commit/d40de55573aa71409b3aa2743531f2a4cb5a4eda)), closes [#28](https://github.com/pchuri/confluence-cli/issues/28)
|
|
49
|
-
|
|
50
|
-
# [1.13.0](https://github.com/pchuri/confluence-cli/compare/v1.12.1...v1.13.0) (2026-01-08)
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
### Features
|
|
54
|
-
|
|
55
|
-
* add children command to list child pages ([#27](https://github.com/pchuri/confluence-cli/issues/27)) ([7e8b4ed](https://github.com/pchuri/confluence-cli/commit/7e8b4ed1b0ed69a7e1de52dfaf0c1ff36973f78b))
|
|
56
|
-
|
|
57
|
-
## [1.12.1](https://github.com/pchuri/confluence-cli/compare/v1.12.0...v1.12.1) (2025-12-31)
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
### Bug Fixes
|
|
61
|
-
|
|
62
|
-
* align README with CLI behavior ([#26](https://github.com/pchuri/confluence-cli/issues/26)) ([b24c7cf](https://github.com/pchuri/confluence-cli/commit/b24c7cf4a645383812a1cb7239b1db41ded77f8d))
|
|
63
|
-
|
|
64
|
-
# [1.12.0](https://github.com/pchuri/confluence-cli/compare/v1.11.1...v1.12.0) (2025-12-31)
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
### Features
|
|
68
|
-
|
|
69
|
-
* add page delete command ([#25](https://github.com/pchuri/confluence-cli/issues/25)) ([bc3e412](https://github.com/pchuri/confluence-cli/commit/bc3e412a6ccd0774d62ab0816a6c2735cbd470a4))
|
|
70
|
-
|
|
71
|
-
## [1.11.1](https://github.com/pchuri/confluence-cli/compare/v1.11.0...v1.11.1) (2025-12-17)
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
### Bug Fixes
|
|
75
|
-
|
|
76
|
-
* support children macro, improve macro handling, and filter attachments ([#23](https://github.com/pchuri/confluence-cli/issues/23)) ([15b721a](https://github.com/pchuri/confluence-cli/commit/15b721acdc296e72470ee438c9fe3470e09ae52e))
|
|
77
|
-
|
|
78
|
-
# [1.11.0](https://github.com/pchuri/confluence-cli/compare/v1.10.1...v1.11.0) (2025-12-12)
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
### Features
|
|
82
|
-
|
|
83
|
-
* Support for Confluence display URLs ([#20](https://github.com/pchuri/confluence-cli/issues/20)) ([3bda7c2](https://github.com/pchuri/confluence-cli/commit/3bda7c2aad8ec02dac60f3b7c34c31b549a31cce))
|
|
84
|
-
|
|
85
|
-
## [1.10.1](https://github.com/pchuri/confluence-cli/compare/v1.10.0...v1.10.1) (2025-12-08)
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
### Bug Fixes
|
|
89
|
-
|
|
90
|
-
* improve markdown export and attachment download ([#19](https://github.com/pchuri/confluence-cli/issues/19)) ([978275d](https://github.com/pchuri/confluence-cli/commit/978275dbe71eea83138bbd537ce7d4edda8180f8))
|
|
91
|
-
|
|
92
|
-
# [1.10.0](https://github.com/pchuri/confluence-cli/compare/v1.9.0...v1.10.0) (2025-12-05)
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
### Features
|
|
96
|
-
|
|
97
|
-
* export page with attachments ([#18](https://github.com/pchuri/confluence-cli/issues/18)) ([bdd9da4](https://github.com/pchuri/confluence-cli/commit/bdd9da474f13a8b6f96e64836443f65f846257a2))
|
|
98
|
-
|
|
99
|
-
# [1.9.0](https://github.com/pchuri/confluence-cli/compare/v1.8.0...v1.9.0) (2025-12-04)
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
### Features
|
|
103
|
-
|
|
104
|
-
* add attachments list and download command ([#17](https://github.com/pchuri/confluence-cli/issues/17)) ([fb3d4f8](https://github.com/pchuri/confluence-cli/commit/fb3d4f81a3926fec832a39c78f4eda3b4a22130a))
|
|
105
|
-
|
|
106
|
-
# [1.8.0](https://github.com/pchuri/confluence-cli/compare/v1.7.0...v1.8.0) (2025-09-28)
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
### Features
|
|
110
|
-
|
|
111
|
-
* make Confluence API path configurable ([#14](https://github.com/pchuri/confluence-cli/issues/14)) ([be000e0](https://github.com/pchuri/confluence-cli/commit/be000e0d92881d65329b84bad6555dcad0bbb455)), closes [#13](https://github.com/pchuri/confluence-cli/issues/13)
|
|
112
|
-
|
|
113
|
-
## [Unreleased]
|
|
114
|
-
|
|
115
|
-
### Added
|
|
116
|
-
- Make the Confluence REST base path configurable to support both `/rest/api` and `/wiki/rest/api`.
|
|
117
|
-
|
|
118
|
-
# [1.7.0](https://github.com/pchuri/confluence-cli/compare/v1.6.0...v1.7.0) (2025-09-28)
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
### Features
|
|
122
|
-
|
|
123
|
-
* support basic auth for Atlassian API tokens ([#12](https://github.com/pchuri/confluence-cli/issues/12)) ([e80ea9b](https://github.com/pchuri/confluence-cli/commit/e80ea9b7913d5f497b60bf72149737b6f704c6b8))
|
|
124
|
-
|
|
125
|
-
# [1.6.0](https://github.com/pchuri/confluence-cli/compare/v1.5.0...v1.6.0) (2025-09-05)
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
### Features
|
|
129
|
-
|
|
130
|
-
* Add copy-tree command for recursive page copying with children ([#9](https://github.com/pchuri/confluence-cli/issues/9)) ([29efa5b](https://github.com/pchuri/confluence-cli/commit/29efa5b2f8edeee1c5072ad8d7077f38f860c2ba))
|
|
131
|
-
|
|
132
|
-
# [1.5.0](https://github.com/pchuri/confluence-cli/compare/v1.4.1...v1.5.0) (2025-08-13)
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
### Features
|
|
136
|
-
|
|
137
|
-
* Align README with implementation and fix update command ([#7](https://github.com/pchuri/confluence-cli/issues/7)) ([87f48e0](https://github.com/pchuri/confluence-cli/commit/87f48e03c6310bb9bfc7fda2930247c0d61414ec))
|
|
138
|
-
|
|
139
|
-
## [1.4.1](https://github.com/pchuri/confluence-cli/compare/v1.4.0...v1.4.1) (2025-06-30)
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
### Bug Fixes
|
|
143
|
-
|
|
144
|
-
* correct version display in CLI ([#6](https://github.com/pchuri/confluence-cli/issues/6)) ([36f8419](https://github.com/pchuri/confluence-cli/commit/36f8419b309ae1ff99fa94c12ace9a527ee3f162))
|
|
145
|
-
|
|
146
|
-
# [1.4.0](https://github.com/pchuri/confluence-cli/compare/v1.3.2...v1.4.0) (2025-06-30)
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
### Features
|
|
150
|
-
|
|
151
|
-
* Enhanced Markdown Support with Bidirectional Conversion ([#5](https://github.com/pchuri/confluence-cli/issues/5)) ([d17771b](https://github.com/pchuri/confluence-cli/commit/d17771b40d8d60ed68c0ac0a3594fed6b9a4e771))
|
|
152
|
-
|
|
153
|
-
## [1.3.2](https://github.com/pchuri/confluence-cli/compare/v1.3.1...v1.3.2) (2025-06-27)
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
### Bug Fixes
|
|
157
|
-
|
|
158
|
-
* resolve merge conflict in CHANGELOG.md ([8565c1a](https://github.com/pchuri/confluence-cli/commit/8565c1a90243663f206285e5af3616541ee1a1d0))
|
|
159
|
-
|
|
160
|
-
## [1.3.1](https://github.com/pchuri/confluence-cli/compare/v1.3.0...v1.3.1) (2025-06-27)
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
### Bug Fixes
|
|
164
|
-
|
|
165
|
-
* clean up duplicate CHANGELOG entries ([0163deb](https://github.com/pchuri/confluence-cli/commit/0163deb7f007e1d64ce4693eb8e86280d27eb6cc))
|
|
166
|
-
|
|
167
|
-
# [1.3.0](https://github.com/pchuri/confluence-cli/compare/v1.2.0...v1.3.0) (2025-06-27)
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
### Bug Fixes
|
|
171
|
-
|
|
172
|
-
* improve format handling based on production testing ([820f9cd](https://github.com/pchuri/confluence-cli/commit/820f9cdc7e59b6aa4b676eda6cff7e22865ec8fb))
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
### Features
|
|
176
|
-
|
|
177
|
-
* implement page creation and update capabilities ([3c43b19](https://github.com/pchuri/confluence-cli/commit/3c43b19765f94318d01fea3a22b324ada00a77d1))
|
|
178
|
-
|
|
179
|
-
# [1.2.1](https://github.com/pchuri/confluence-cli/compare/v1.2.0...v1.2.1) (2025-06-27)
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
### Bug Fixes
|
|
183
|
-
|
|
184
|
-
* **format handling**: improve compatibility across Confluence instances
|
|
185
|
-
- Switch from 'html' macro to 'markdown' macro for better compatibility
|
|
186
|
-
- Change HTML processing to direct Storage format (no macro wrapper)
|
|
187
|
-
- Add markdownToNativeStorage method for alternative conversion
|
|
188
|
-
- Fix issues discovered during production testing in real Confluence environments
|
|
189
|
-
|
|
190
|
-
# [1.2.0](https://github.com/pchuri/confluence-cli/compare/v1.1.0...v1.2.0) (2025-06-27)
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
### Features
|
|
194
|
-
|
|
195
|
-
* **page management**: add page creation and update capabilities ([#2](https://github.com/pchuri/confluence-cli/issues/2)) ([b814ddf](https://github.com/pchuri/confluence-cli/commit/b814ddfd056aeac83cc7eb5d8d6db47ba9c70cdf))
|
|
196
|
-
- `confluence create` - Create new pages with support for Markdown, HTML, and Storage formats
|
|
197
|
-
- `confluence update` - Update existing page content and titles
|
|
198
|
-
- `confluence edit` - Export page content for editing workflow
|
|
199
|
-
- Support for reading content from files or inline
|
|
200
|
-
- Markdown to Confluence Storage format conversion
|
|
201
|
-
* **content formats**: support multiple input formats
|
|
202
|
-
- Markdown format with automatic conversion using `markdown` macro
|
|
203
|
-
- HTML format with direct Storage format integration
|
|
204
|
-
- Native Confluence Storage format
|
|
205
|
-
* **examples**: add sample files and demo scripts for new features
|
|
206
|
-
|
|
207
|
-
### Breaking Changes
|
|
208
|
-
|
|
209
|
-
* None - all new features are additive
|
|
210
|
-
|
|
211
|
-
# [1.1.0](https://github.com/pchuri/confluence-cli/compare/v1.0.0...v1.1.0) (2025-06-26)
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
### Features
|
|
215
|
-
|
|
216
|
-
* add analytics tracking to spaces command ([265e8f4](https://github.com/pchuri/confluence-cli/commit/265e8f42b5ba86fb50398e8b1fcfd1d85fcc54d9))
|
|
217
|
-
* add community feedback and analytics infrastructure ([a7ff6e8](https://github.com/pchuri/confluence-cli/commit/a7ff6e87cdc92d98f3d927ee98fac9e33aedbaae))
|
|
218
|
-
|
|
219
|
-
# 1.0.0 (2025-06-26)
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
### Bug Fixes
|
|
223
|
-
|
|
224
|
-
* add explicit permissions for GitHub Actions ([fa36b29](https://github.com/pchuri/confluence-cli/commit/fa36b2974b1261c144a415ced324383b35a938fb))
|
|
225
|
-
* add NODE_AUTH_TOKEN for npm authentication ([2031314](https://github.com/pchuri/confluence-cli/commit/2031314ad01fc1d9b4f9557a3d1321a046cad8f3))
|
|
226
|
-
* resolve eslint errors and npm publish warnings ([b93285e](https://github.com/pchuri/confluence-cli/commit/b93285ee098d96c8b750dbf2be5a93f28f44706c))
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
### Features
|
|
230
|
-
|
|
231
|
-
* initial release of confluence-cli ([ec04e06](https://github.com/pchuri/confluence-cli/commit/ec04e06bb0c785dcff84dabcafeeb60bf9e1658f))
|
|
232
|
-
|
|
233
|
-
# Confluence CLI Changelog
|
|
234
|
-
|
|
235
|
-
All notable changes to this project will be documented in this file.
|
|
236
|
-
|
|
237
|
-
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
238
|
-
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
239
|
-
|
|
240
|
-
## [1.0.0] - 2025-06-26
|
|
241
|
-
|
|
242
|
-
### Added
|
|
243
|
-
- Initial release of Confluence CLI
|
|
244
|
-
- Read Confluence pages by ID or URL
|
|
245
|
-
- Search functionality with customizable limits
|
|
246
|
-
- Page information display
|
|
247
|
-
- List all Confluence spaces
|
|
248
|
-
- Interactive configuration setup
|
|
249
|
-
- Environment variable support
|
|
250
|
-
- HTML and text output formats
|
|
251
|
-
- Comprehensive README with examples
|
|
252
|
-
- MIT License
|
|
253
|
-
|
|
254
|
-
### Features
|
|
255
|
-
- `confluence init` - Interactive configuration setup
|
|
256
|
-
- `confluence read <pageId>` - Read page content with format options
|
|
257
|
-
- `confluence info <pageId>` - Display page information
|
|
258
|
-
- `confluence search <query>` - Search pages with optional limit
|
|
259
|
-
- `confluence spaces` - List all available spaces
|
|
260
|
-
|
|
261
|
-
### Dependencies
|
|
262
|
-
- commander for CLI framework
|
|
263
|
-
- axios for HTTP requests
|
|
264
|
-
- chalk for colored output
|
|
265
|
-
- inquirer for interactive prompts
|
|
266
|
-
- html-to-text for content conversion
|
|
267
|
-
- ora for loading indicators
|
package/CONTRIBUTING.md
DELETED
|
@@ -1,246 +0,0 @@
|
|
|
1
|
-
# Contributing to Confluence CLI
|
|
2
|
-
|
|
3
|
-
Thank you for your interest in contributing to Confluence CLI! This document provides guidelines and information about contributing to this project.
|
|
4
|
-
|
|
5
|
-
## Table of Contents
|
|
6
|
-
|
|
7
|
-
- [Code of Conduct](#code-of-conduct)
|
|
8
|
-
- [Getting Started](#getting-started)
|
|
9
|
-
- [Development Setup](#development-setup)
|
|
10
|
-
- [Making Changes](#making-changes)
|
|
11
|
-
- [Testing](#testing)
|
|
12
|
-
- [Submitting Changes](#submitting-changes)
|
|
13
|
-
- [Coding Standards](#coding-standards)
|
|
14
|
-
|
|
15
|
-
## Code of Conduct
|
|
16
|
-
|
|
17
|
-
This project adheres to a code of conduct. By participating, you are expected to uphold this code. Please be respectful and considerate in all interactions.
|
|
18
|
-
|
|
19
|
-
## Getting Started
|
|
20
|
-
|
|
21
|
-
1. Fork the repository on GitHub
|
|
22
|
-
2. Clone your fork locally
|
|
23
|
-
3. Create a branch for your changes
|
|
24
|
-
4. Make your changes
|
|
25
|
-
5. Test your changes
|
|
26
|
-
6. Submit a pull request
|
|
27
|
-
|
|
28
|
-
## Development Setup
|
|
29
|
-
|
|
30
|
-
```bash
|
|
31
|
-
# Clone your fork
|
|
32
|
-
git clone https://github.com/your-username/confluence-cli.git
|
|
33
|
-
cd confluence-cli
|
|
34
|
-
|
|
35
|
-
# Install dependencies
|
|
36
|
-
npm install
|
|
37
|
-
|
|
38
|
-
# Set up your test environment
|
|
39
|
-
export CONFLUENCE_DOMAIN="your-test-domain.atlassian.net"
|
|
40
|
-
export CONFLUENCE_API_TOKEN="your-test-token"
|
|
41
|
-
|
|
42
|
-
# Test the CLI locally
|
|
43
|
-
node bin/confluence.js --help
|
|
44
|
-
```
|
|
45
|
-
|
|
46
|
-
## Making Changes
|
|
47
|
-
|
|
48
|
-
### Branch Naming
|
|
49
|
-
|
|
50
|
-
Use descriptive branch names:
|
|
51
|
-
- `feature/add-page-creation` - for new features
|
|
52
|
-
- `fix/search-pagination` - for bug fixes
|
|
53
|
-
- `docs/update-readme` - for documentation updates
|
|
54
|
-
- `refactor/client-architecture` - for refactoring
|
|
55
|
-
|
|
56
|
-
### Commit Messages
|
|
57
|
-
|
|
58
|
-
Write clear, descriptive commit messages:
|
|
59
|
-
```
|
|
60
|
-
feat: add page creation functionality
|
|
61
|
-
|
|
62
|
-
- Add create command to CLI
|
|
63
|
-
- Implement createPage method in client
|
|
64
|
-
- Add tests for page creation
|
|
65
|
-
- Update README with new command
|
|
66
|
-
```
|
|
67
|
-
|
|
68
|
-
Use conventional commit format:
|
|
69
|
-
- `feat:` - new features
|
|
70
|
-
- `fix:` - bug fixes
|
|
71
|
-
- `docs:` - documentation changes
|
|
72
|
-
- `style:` - formatting changes
|
|
73
|
-
- `refactor:` - code refactoring
|
|
74
|
-
- `test:` - adding tests
|
|
75
|
-
- `chore:` - maintenance tasks
|
|
76
|
-
|
|
77
|
-
## Testing
|
|
78
|
-
|
|
79
|
-
```bash
|
|
80
|
-
# Run all tests
|
|
81
|
-
npm test
|
|
82
|
-
|
|
83
|
-
# Run tests in watch mode
|
|
84
|
-
npm run test:watch
|
|
85
|
-
|
|
86
|
-
# Check test coverage
|
|
87
|
-
npm run test:coverage
|
|
88
|
-
|
|
89
|
-
# Manual testing
|
|
90
|
-
node bin/confluence.js read 123456789
|
|
91
|
-
```
|
|
92
|
-
|
|
93
|
-
### Test Guidelines
|
|
94
|
-
|
|
95
|
-
- Write tests for new functionality
|
|
96
|
-
- Ensure existing tests pass
|
|
97
|
-
- Aim for good test coverage
|
|
98
|
-
- Use descriptive test names
|
|
99
|
-
- Mock external API calls
|
|
100
|
-
|
|
101
|
-
## Submitting Changes
|
|
102
|
-
|
|
103
|
-
1. **Push your changes** to your fork
|
|
104
|
-
2. **Create a pull request** against the main branch
|
|
105
|
-
3. **Fill out the PR template** with:
|
|
106
|
-
- Description of changes
|
|
107
|
-
- Type of change (bug fix, feature, etc.)
|
|
108
|
-
- Testing performed
|
|
109
|
-
- Screenshots (if applicable)
|
|
110
|
-
|
|
111
|
-
### Pull Request Guidelines
|
|
112
|
-
|
|
113
|
-
- Keep PRs focused and atomic
|
|
114
|
-
- Include tests for new functionality
|
|
115
|
-
- Update documentation as needed
|
|
116
|
-
- Ensure CI passes
|
|
117
|
-
- Request review from maintainers
|
|
118
|
-
|
|
119
|
-
## Coding Standards
|
|
120
|
-
|
|
121
|
-
### JavaScript Style
|
|
122
|
-
|
|
123
|
-
- Use ES6+ features when appropriate
|
|
124
|
-
- Follow existing code style
|
|
125
|
-
- Use meaningful variable names
|
|
126
|
-
- Add comments for complex logic
|
|
127
|
-
- Keep functions small and focused
|
|
128
|
-
|
|
129
|
-
### Markdown Support
|
|
130
|
-
|
|
131
|
-
The CLI includes enhanced markdown support with:
|
|
132
|
-
|
|
133
|
-
- **Native Confluence Storage Format**: Converts markdown to native Confluence elements instead of HTML macros
|
|
134
|
-
- **Confluence Extensions**: Support for admonitions (`[!info]`, `[!warning]`, `[!note]`)
|
|
135
|
-
- **Bidirectional Conversion**: Convert from markdown to storage format and back
|
|
136
|
-
- **Rich Elements**: Tables, code blocks, lists, links, and formatting
|
|
137
|
-
|
|
138
|
-
Example markdown with Confluence extensions:
|
|
139
|
-
```markdown
|
|
140
|
-
# My Page
|
|
141
|
-
|
|
142
|
-
[!info]
|
|
143
|
-
This is an info admonition that will render as a Confluence info macro.
|
|
144
|
-
|
|
145
|
-
```javascript
|
|
146
|
-
console.log("Code blocks preserve syntax highlighting");
|
|
147
|
-
```
|
|
148
|
-
|
|
149
|
-
| Feature | Status |
|
|
150
|
-
|---------|--------|
|
|
151
|
-
| Tables | ✅ |
|
|
152
|
-
| Lists | ✅ |
|
|
153
|
-
```
|
|
154
|
-
|
|
155
|
-
### File Structure
|
|
156
|
-
|
|
157
|
-
```
|
|
158
|
-
bin/ # CLI entry points
|
|
159
|
-
lib/ # Core library code
|
|
160
|
-
├── confluence-client.js
|
|
161
|
-
├── config.js
|
|
162
|
-
└── utils.js
|
|
163
|
-
tests/ # Test files
|
|
164
|
-
docs/ # Additional documentation
|
|
165
|
-
```
|
|
166
|
-
|
|
167
|
-
### Error Handling
|
|
168
|
-
|
|
169
|
-
- Always handle errors gracefully
|
|
170
|
-
- Provide helpful error messages
|
|
171
|
-
- Use appropriate exit codes
|
|
172
|
-
- Log errors appropriately
|
|
173
|
-
|
|
174
|
-
### Documentation
|
|
175
|
-
|
|
176
|
-
- Update README for new features
|
|
177
|
-
- Add JSDoc comments for functions
|
|
178
|
-
- Update CHANGELOG for releases
|
|
179
|
-
- Include usage examples
|
|
180
|
-
|
|
181
|
-
## Feature Requests
|
|
182
|
-
|
|
183
|
-
Before implementing major features:
|
|
184
|
-
|
|
185
|
-
1. **Check existing issues** to avoid duplication
|
|
186
|
-
2. **Create an issue** to discuss the feature
|
|
187
|
-
3. **Get maintainer feedback** before starting work
|
|
188
|
-
4. **Follow the agreed approach** in implementation
|
|
189
|
-
|
|
190
|
-
## Bug Reports
|
|
191
|
-
|
|
192
|
-
When reporting bugs:
|
|
193
|
-
|
|
194
|
-
1. **Check existing issues** first
|
|
195
|
-
2. **Provide reproduction steps**
|
|
196
|
-
3. **Include environment details**:
|
|
197
|
-
- Node.js version
|
|
198
|
-
- OS and version
|
|
199
|
-
- CLI version
|
|
200
|
-
4. **Share error messages** and logs
|
|
201
|
-
|
|
202
|
-
## Development Tips
|
|
203
|
-
|
|
204
|
-
### Local Testing
|
|
205
|
-
|
|
206
|
-
```bash
|
|
207
|
-
# Test against your Confluence instance
|
|
208
|
-
export CONFLUENCE_DOMAIN="your-domain.atlassian.net"
|
|
209
|
-
export CONFLUENCE_API_TOKEN="your-token"
|
|
210
|
-
|
|
211
|
-
# Test commands
|
|
212
|
-
node bin/confluence.js spaces
|
|
213
|
-
node bin/confluence.js search "test"
|
|
214
|
-
node bin/confluence.js read 123456789
|
|
215
|
-
```
|
|
216
|
-
|
|
217
|
-
### Debugging
|
|
218
|
-
|
|
219
|
-
```bash
|
|
220
|
-
# Enable debug mode
|
|
221
|
-
DEBUG=confluence-cli node bin/confluence.js read 123456789
|
|
222
|
-
|
|
223
|
-
# Use Node.js debugger
|
|
224
|
-
node --inspect-brk bin/confluence.js read 123456789
|
|
225
|
-
```
|
|
226
|
-
|
|
227
|
-
## Release Process
|
|
228
|
-
|
|
229
|
-
For maintainers:
|
|
230
|
-
|
|
231
|
-
1. Update version in `package.json`
|
|
232
|
-
2. Update `CHANGELOG.md`
|
|
233
|
-
3. Create git tag
|
|
234
|
-
4. Push to npm
|
|
235
|
-
5. Create GitHub release
|
|
236
|
-
|
|
237
|
-
## Questions?
|
|
238
|
-
|
|
239
|
-
If you have questions about contributing:
|
|
240
|
-
|
|
241
|
-
1. Check existing documentation
|
|
242
|
-
2. Search closed issues
|
|
243
|
-
3. Ask in a new issue
|
|
244
|
-
4. Contact maintainers
|
|
245
|
-
|
|
246
|
-
Thank you for contributing to Confluence CLI! 🚀
|
package/docs/PROMOTION.md
DELETED
|
@@ -1,63 +0,0 @@
|
|
|
1
|
-
# GitHub Repository Topics
|
|
2
|
-
|
|
3
|
-
When setting up your GitHub repository, add these topics for better discoverability:
|
|
4
|
-
|
|
5
|
-
## Suggested Topics:
|
|
6
|
-
- `confluence`
|
|
7
|
-
- `atlassian`
|
|
8
|
-
- `cli`
|
|
9
|
-
- `command-line`
|
|
10
|
-
- `wiki`
|
|
11
|
-
- `documentation`
|
|
12
|
-
- `nodejs`
|
|
13
|
-
- `javascript`
|
|
14
|
-
- `api-client`
|
|
15
|
-
- `automation`
|
|
16
|
-
- `developer-tools`
|
|
17
|
-
- `productivity`
|
|
18
|
-
|
|
19
|
-
## How to add topics:
|
|
20
|
-
1. Go to https://github.com/pchuri/confluence-cli
|
|
21
|
-
2. Click the ⚙️ gear icon next to "About"
|
|
22
|
-
3. Add the topics above in the "Topics" field
|
|
23
|
-
4. Add a description: "A powerful command-line interface for Atlassian Confluence"
|
|
24
|
-
5. Add website: https://www.npmjs.com/package/confluence-cli
|
|
25
|
-
|
|
26
|
-
## Social Media Promotion Ideas:
|
|
27
|
-
|
|
28
|
-
### Twitter/X Posts:
|
|
29
|
-
```
|
|
30
|
-
🚀 Just released confluence-cli v1.0!
|
|
31
|
-
|
|
32
|
-
A powerful CLI tool for @Atlassian Confluence:
|
|
33
|
-
✅ Read pages from terminal
|
|
34
|
-
✅ Search documentation
|
|
35
|
-
✅ List spaces
|
|
36
|
-
✅ Works with environment variables
|
|
37
|
-
|
|
38
|
-
Perfect for automation & DevOps workflows!
|
|
39
|
-
|
|
40
|
-
#CLI #Confluence #DevTools #OpenSource
|
|
41
|
-
https://github.com/pchuri/confluence-cli
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
### LinkedIn Post:
|
|
45
|
-
```
|
|
46
|
-
Excited to share my latest open-source project: confluence-cli! 🎉
|
|
47
|
-
|
|
48
|
-
As someone who works with Confluence daily, I built this CLI tool to streamline documentation workflows. Now you can:
|
|
49
|
-
|
|
50
|
-
• Read Confluence pages from your terminal
|
|
51
|
-
• Search across your wiki content
|
|
52
|
-
• Integrate with CI/CD pipelines
|
|
53
|
-
• Automate documentation tasks
|
|
54
|
-
|
|
55
|
-
Available on NPM and fully open-source. Would love your feedback!
|
|
56
|
-
|
|
57
|
-
#OpenSource #CLI #Confluence #DevTools #Automation
|
|
58
|
-
```
|
|
59
|
-
|
|
60
|
-
### Dev.to Article Ideas:
|
|
61
|
-
1. "Building a CLI Tool for Confluence: From Bash Functions to NPM Package"
|
|
62
|
-
2. "How to Automate Your Documentation Workflow with Confluence CLI"
|
|
63
|
-
3. "Open Source Journey: Lessons Learned Building confluence-cli"
|
package/eslint.config.js
DELETED
|
@@ -1,33 +0,0 @@
|
|
|
1
|
-
const util = require('util');
|
|
2
|
-
const js = require('@eslint/js');
|
|
3
|
-
const globals = require('globals');
|
|
4
|
-
|
|
5
|
-
if (typeof global.structuredClone !== 'function') {
|
|
6
|
-
global.structuredClone = typeof util.structuredClone === 'function'
|
|
7
|
-
? util.structuredClone
|
|
8
|
-
: (value) => JSON.parse(JSON.stringify(value));
|
|
9
|
-
}
|
|
10
|
-
|
|
11
|
-
module.exports = [
|
|
12
|
-
js.configs.recommended,
|
|
13
|
-
{
|
|
14
|
-
files: ['**/*.js'],
|
|
15
|
-
languageOptions: {
|
|
16
|
-
ecmaVersion: 2021,
|
|
17
|
-
sourceType: 'module',
|
|
18
|
-
globals: {
|
|
19
|
-
...globals.node,
|
|
20
|
-
...globals.jest
|
|
21
|
-
}
|
|
22
|
-
},
|
|
23
|
-
rules: {
|
|
24
|
-
indent: ['error', 2],
|
|
25
|
-
'linebreak-style': ['error', 'unix'],
|
|
26
|
-
quotes: ['error', 'single'],
|
|
27
|
-
semi: ['error', 'always'],
|
|
28
|
-
'no-unused-vars': ['error', { argsIgnorePattern: '^_', caughtErrors: 'none' }],
|
|
29
|
-
'no-console': 'off',
|
|
30
|
-
'no-process-exit': 'off'
|
|
31
|
-
}
|
|
32
|
-
}
|
|
33
|
-
];
|