@bestend/confluence-cli 1.16.0 → 2.0.0

package/docs/PROMOTION.md

@@ -1,63 +0,0 @@
-# GitHub Repository Topics
-
-When setting up your GitHub repository, add these topics for better discoverability:
-
-## Suggested Topics:
-- `confluence`
-- `atlassian`
-- `cli`
-- `command-line`
-- `wiki`
-- `documentation`
-- `nodejs`
-- `javascript`
-- `api-client`
-- `automation`
-- `developer-tools`
-- `productivity`
-
-## How to add topics:
-1. Go to https://github.com/pchuri/confluence-cli
-2. Click the ⚙️ gear icon next to "About"
-3. Add the topics above in the "Topics" field
-4. Add a description: "A powerful command-line interface for Atlassian Confluence"
-5. Add website: https://www.npmjs.com/package/confluence-cli
-
-## Social Media Promotion Ideas:
-
-### Twitter/X Posts:
-```
-🚀 Just released confluence-cli v1.0! 
-
-A powerful CLI tool for @Atlassian Confluence:
-✅ Read pages from terminal
-✅ Search documentation  
-✅ List spaces
-✅ Works with environment variables
-
-Perfect for automation & DevOps workflows!
-
-#CLI #Confluence #DevTools #OpenSource
-https://github.com/pchuri/confluence-cli
-```
-
-### LinkedIn Post:
-```
-Excited to share my latest open-source project: confluence-cli! 🎉
-
-As someone who works with Confluence daily, I built this CLI tool to streamline documentation workflows. Now you can:
-
-• Read Confluence pages from your terminal
-• Search across your wiki content
-• Integrate with CI/CD pipelines
-• Automate documentation tasks
-
-Available on NPM and fully open-source. Would love your feedback!
-
-#OpenSource #CLI #Confluence #DevTools #Automation
-```
-
-### Dev.to Article Ideas:
-1. "Building a CLI Tool for Confluence: From Bash Functions to NPM Package"
-2. "How to Automate Your Documentation Workflow with Confluence CLI"
-3. "Open Source Journey: Lessons Learned Building confluence-cli"

package/eslint.config.js

@@ -1,33 +0,0 @@
-const util = require('util');
-const js = require('@eslint/js');
-const globals = require('globals');
-
-if (typeof global.structuredClone !== 'function') {
-  global.structuredClone = typeof util.structuredClone === 'function'
-    ? util.structuredClone
-    : (value) => JSON.parse(JSON.stringify(value));
-}
-
-module.exports = [
-  js.configs.recommended,
-  {
-    files: ['**/*.js'],
-    languageOptions: {
-      ecmaVersion: 2021,
-      sourceType: 'module',
-      globals: {
-        ...globals.node,
-        ...globals.jest
-      }
-    },
-    rules: {
-      indent: ['error', 2],
-      'linebreak-style': ['error', 'unix'],
-      quotes: ['error', 'single'],
-      semi: ['error', 'always'],
-      'no-unused-vars': ['error', { argsIgnorePattern: '^_', caughtErrors: 'none' }],
-      'no-console': 'off',
-      'no-process-exit': 'off'
-    }
-  }
-];

package/examples/copy-tree-example.sh

@@ -1,117 +0,0 @@
-#!/bin/bash
-
-# Confluence CLI - Copy Page Tree Example
-# This script shows how to copy a page and all its descendants to a new location.
-
-echo "📋 Confluence CLI - Copy Page Tree Example"
-echo "=================================================="
-
-# Prerequisites
-echo ""
-echo "📝 Prerequisites:"
-echo "- confluence CLI is set up (confluence init)"
-echo "- You have access to source and target locations"
-echo "- You have permissions to create pages"
-echo ""
-
-# Step 1: Find the source page
-echo "1️⃣ Find the source page"
-echo "=============================="
-echo ""
-echo "Method 1: Find by title"
-echo "confluence find \"Project Docs\" --space MYTEAM"
-echo ""
-echo "Method 2: Search"
-echo "confluence search \"Project\""
-echo ""
-echo "📝 Note the source page ID from the output (e.g., 123456789)"
-echo ""
-
-# Step 2: Find the target parent page
-echo "2️⃣ Find the target parent page"
-echo "========================="
-echo ""
-echo "confluence find \"Backup\" --space BACKUP"
-echo "or"
-echo "confluence find \"Archive\" --space ARCHIVE"
-echo ""
-echo "📝 Note the target parent page ID (e.g., 987654321)"
-echo ""
-
-# Step 3: Run the copy
-echo "3️⃣ Run copy"
-echo "========================"
-echo ""
-
-echo "📄 Basic: copy with all children"
-echo 'confluence copy-tree 123456789 987654321 "Project Docs (Backup)"'
-echo ""
-
-echo "📄 Depth-limited (3 levels)"
-echo 'confluence copy-tree 123456789 987654321 "Project Docs (Summary)" --max-depth 3'
-echo ""
-
-echo "📄 Exclude patterns"
-echo 'confluence copy-tree 123456789 987654321 "Project Docs (Clean)" --exclude "temp*,test*,*draft*"'
-echo ""
-
-echo "📄 Quiet mode"
-echo 'confluence copy-tree 123456789 987654321 --quiet'
-echo ""
-
-echo "📄 Control pacing and naming"
-echo 'confluence copy-tree 123456789 987654321 --delay-ms 150 --copy-suffix " (Backup)"'
-echo ""
-
-# Practical example
-echo "💡 Practical example"
-echo "================="
-echo ""
-echo "# 1. Capture source page ID"
-echo 'SOURCE_ID=$(confluence find "Project Docs" --space MYTEAM | grep "ID:" | awk "{print \$2}")'
-echo ""
-echo "# 2. Capture target parent ID"
-echo 'TARGET_ID=$(confluence find "Backup Folder" --space BACKUP | grep "ID:" | awk "{print \$2}")'
-echo ""
-echo "# 3. Run backup with date suffix"
-echo 'confluence copy-tree $SOURCE_ID $TARGET_ID "Project Docs Backup - $(date +%Y%m%d)"'
-echo ""
-
-# Advanced usage
-echo "🚀 Advanced"
-echo "============="
-echo ""
-echo "1. Large trees with progress"
-echo "   confluence copy-tree 123456789 987654321 | tee copy-log.txt"
-echo ""
-echo "2. Multiple exclude patterns"
-echo "   confluence copy-tree 123456789 987654321 --exclude \"temp*,test*,*draft*,*temp*\""
-echo ""
-echo "3. Shallow copy (only direct children)"
-echo "   confluence copy-tree 123456789 987654321 --max-depth 1"
-echo ""
-
-# Notes and tips
-echo "⚠️  Notes and tips"
-echo "=================="
-echo "- Large trees may take time to copy"
-echo "- A short delay between siblings helps avoid rate limits (tune with --delay-ms)"
-echo "- Partial copies can remain if errors occur"
-echo "- Pages without permission are skipped; run with --fail-on-error to fail the run"
-echo "- Validate links and references after copying"
-echo "- Try with a small tree first"
-echo ""
-
-echo "📊 Verify results"
-echo "================"
-echo "After completion, you can check the results:"
-echo ""
-echo "# Root page info"
-echo "confluence info [NEW_PAGE_ID]"
-echo ""
-echo "# Find copied pages"
-echo "confluence search \"Copy\" --limit 20"
-echo ""
-
-echo "✅ Example complete!"
-echo "Replace example IDs with real ones when running."

package/examples/create-child-page-example.sh

@@ -1,67 +0,0 @@
-#!/bin/bash
-
-#!/bin/bash
-
-# Create a test page under the Project Documentation page
-# This script demonstrates typical Confluence CLI usage.
-
-echo "🔍 Create a test page under Project Documentation"
-echo "================================================"
-
-# Step 1: Find the parent page
-echo ""
-echo "1️⃣ Find the parent page..."
-echo "Run: confluence find \"Project Documentation\" --space MYTEAM"
-echo ""
-
-# For real execution, uncomment below
-# confluence find "Project Documentation" --space MYTEAM
-
-echo "📝 Note the page ID from the output (e.g., 123456789)"
-echo ""
-
-# Step 2: Inspect page info
-echo "2️⃣ Inspect page info..."
-echo "Run: confluence info [PAGE_ID]"
-echo "Example: confluence info 123456789"
-echo ""
-
-# Step 3: Read page content (optional)
-echo "3️⃣ Read content (optional)..."
-echo "Run: confluence read [PAGE_ID] | head -20"
-echo "Example: confluence read 123456789 | head -20"
-echo ""
-
-# Step 4: Create a child test page
-echo "4️⃣ Create child test page..."
-echo ""
-
-# Simple text content
-echo "📄 Option 1: Simple text content"
-echo 'confluence create-child "Test Page - $(date +%Y%m%d)" [PARENT_PAGE_ID] --content "This is a test page created via CLI. Created at: $(date)"'
-echo ""
-
-# From Markdown file
-echo "📄 Option 2: From Markdown file"
-echo "confluence create-child \"Test Documentation - $(date +%Y%m%d)\" [PARENT_PAGE_ID] --file ./sample-page.md --format markdown"
-echo ""
-
-# From HTML content
-echo "📄 Option 3: From HTML content"
-echo 'confluence create-child "Test HTML Page" [PARENT_PAGE_ID] --content "<h1>Test Page</h1><p>This is a <strong>HTML</strong> example page.</p>" --format html'
-echo ""
-
-echo "💡 Practical example:"
-echo "=============================="
-echo "# 1. Get parent page ID"
-echo 'PARENT_ID=$(confluence find "Project Documentation" --space MYTEAM | grep "ID:" | cut -d" " -f2)'
-echo ""
-echo "# 2. Create test page"
-echo 'confluence create-child "Test Page - $(date +%Y%m%d_%H%M)" $PARENT_ID --content "Page for CLI testing."'
-echo ""
-
-echo "⚠️  Notes:"
-echo "- confluence CLI must be set up (confluence init)"
-echo "- You need appropriate permissions on the Confluence instance"
-echo "- Ensure you have page creation permission"
-echo "- Clean up test pages afterward"

package/examples/demo-page-management.sh

@@ -1,68 +0,0 @@
-#!/bin/bash
-
-# Confluence CLI Demo Script
-# This script demonstrates the new page creation and update features
-
-echo "🚀 Confluence CLI - Page Creation Demo"
-echo "======================================"
-
-# Note: Replace with your actual space key and ensure you have confluence-cli configured
-SPACE_KEY="MYTEAM"  # Change this to your space key
-
-echo ""
-echo "1. Creating a page from Markdown file..."
-echo "confluence create \"Sample Page from CLI\" $SPACE_KEY --file ./sample-page.md --format markdown"
-
-echo ""
-echo "2. Creating a page with inline content..."
-echo "confluence create \"Quick Note\" $SPACE_KEY --content \"This is a quick note created from the CLI\" --format storage"
-
-echo ""
-echo "3. Updating a page (replace 123456789 with actual page ID)..."
-echo "confluence update 123456789 --content \"This page has been updated via CLI\""
-
-echo ""
-echo "4. Getting page content for editing..."
-echo "confluence edit 123456789 --output ./page-backup.xml"
-
-echo ""
-echo "5. Searching for pages..."
-echo "confluence search \"CLI\""
-
-echo ""
-echo "6. Listing all spaces..."
-echo "confluence spaces"
-
-echo ""
-echo "7. Finding a page by title..."
-echo "confluence find \"Project Documentation\" --space MYTEAM"
-
-echo ""
-echo "8. Creating a child page under a parent page..."
-echo "confluence create-child \"Test Page\" 123456789 --content \"This is a test page created as a child\""
-
-echo ""
-echo "9. Creating a child page from Markdown file..."
-echo "confluence create-child \"Test Documentation\" 123456789 --file ./sample-page.md --format markdown"
-
-echo ""
-echo "💡 Tips:"
-echo "- Use --format markdown to create pages from Markdown files"
-echo "- Use --format html for HTML content"
-echo "- Use --format storage for Confluence native format"
-echo "- Always backup important pages before updating"
-echo "- Use 'confluence find' to get page IDs by title"
-echo "- Child pages inherit permissions from their parent"
-
-echo ""
-echo "📝 Edit workflow:"
-echo "1. confluence edit [pageId] --output page.xml"
-echo "2. Edit the file with your preferred editor"
-echo "3. confluence update [pageId] --file page.xml --format storage"
-
-echo ""
-echo "🔍 Finding and creating child pages workflow:"
-echo "1. confluence find \"Project Documentation\" --space MYTEAM"
-echo "2. Note the page ID from the result"
-echo "3. confluence create-child \"Meeting Notes\" [parentId] --content \"Child content\""
-echo "4. Or use: confluence create-child \"Technical Docs\" [parentId] --file ./content.md --format markdown"

package/examples/demo.sh

@@ -1,43 +0,0 @@
-#!/bin/bash
-
-# Example script showing how to use confluence-cli
-
-echo "🚀 Confluence CLI Examples"
-echo "========================="
-
-# Check if confluence command is available
-if ! command -v confluence &> /dev/null; then
-    echo "❌ confluence command not found. Please install confluence-cli first:"
-    echo "   npm install -g confluence-cli"
-    exit 1
-fi
-
-echo ""
-echo "📋 Listing all spaces..."
-confluence spaces
-
-echo ""
-echo "🔍 Searching for 'API' documentation..."
-confluence search "API" --limit 5
-
-echo ""
-echo "ℹ️  Getting information about a specific page..."
-# Replace this with an actual page ID from your Confluence
-read -p "Enter a page ID to get info: " PAGE_ID
-if [ ! -z "$PAGE_ID" ]; then
-    confluence info "$PAGE_ID"
-    
-    echo ""
-    read -p "Do you want to read this page? (y/N): " READ_PAGE
-    if [ "$READ_PAGE" = "y" ] || [ "$READ_PAGE" = "Y" ]; then
-        echo ""
-        echo "📖 Reading page content..."
-        confluence read "$PAGE_ID" | head -20
-        echo ""
-        echo "(Showing first 20 lines only)"
-    fi
-fi
-
-echo ""
-echo "✅ Examples completed!"
-echo "💡 Run 'confluence --help' for more commands"

package/examples/sample-page.md

@@ -1,30 +0,0 @@
-# Welcome to Confluence CLI
-
-This is a sample page created using the **Confluence CLI** tool.
-
-## Features
-
-- Easy page creation from Markdown files
-- Support for multiple content formats
-- Command-line interface for automation
-
-## Code Example
-
-```javascript
-const client = new ConfluenceClient(config);
-await client.createPage('My Page', 'SPACE', content, 'markdown');
-```
-
-## Lists
-
-1. First item
-2. Second item
-3. Third item
-
-- Bullet point one
-- Bullet point two
-- Bullet point three
-
----
-
-*Created with ❤️ using confluence-cli*

package/jest.config.js

@@ -1,13 +0,0 @@
-module.exports = {
-  testEnvironment: 'node',
-  collectCoverageFrom: [
-    'lib/**/*.js',
-    'bin/**/*.js',
-    '!node_modules/**'
-  ],
-  coverageDirectory: 'coverage',
-  coverageReporters: ['text', 'lcov', 'html'],
-  testMatch: [
-    '**/tests/**/*.test.js'
-  ]
-};

package/llms.txt

@@ -1,46 +0,0 @@
-# Confluence CLI
-
-> A powerful command-line interface for Atlassian Confluence that allows you to read, search, and manage your Confluence content from the terminal.
-
-This CLI tool provides a comprehensive set of commands for interacting with Confluence. Key features include creating, reading, updating, and searching for pages. It supports various content formats like markdown and HTML.
-
-To get started, install the tool via npm and initialize the configuration:
-```sh
-npm install -g confluence-cli
-confluence init
-```
-
-## Documentation
-
-- [README.md](./README.md): Main documentation with installation, usage, and command reference.
-
-## Core Source Code
-
-- [bin/confluence.js](./bin/confluence.js): The main entry point for the CLI, defines commands and argument parsing.
-- [lib/confluence-client.js](./lib/confluence-client.js): The client library for interacting with the Confluence REST API.
-- [package.json](./package.json): Project metadata, dependencies, and scripts.
-
-## Recent Changes & Fixes
-
-This section summarizes recent improvements to align the codebase with its documentation and fix bugs.
-
-### `update` Command Logic and Documentation:
-- **Inconsistency:** The `README.md` suggested that updating a page's title without changing its content was possible. However, the implementation in `bin/confluence.js` incorrectly threw an error if the `--content` or `--file` flags were not provided, making title-only updates impossible.
-- **Fix:**
-    - Modified `updatePage` in `lib/confluence-client.js` to fetch and re-use existing page content if no new content is provided.
-    - Adjusted validation in `bin/confluence.js` for the `update` command to only require one of `--title`, `--content`, or `--file`.
-    - Updated `README.md` with an example of a title-only update.
-
-### Incomplete `README.md` Command Reference:
-- **Inconsistency:** The main command table in `README.md` was missing several commands (`create`, `create-child`, `update`, `edit`, `find`).
-- **Fix:** Expanded the command table in `README.md` to include all available commands.
-
-### Misleading `read` Command URL Examples:
-- **Inconsistency:** The documentation for the `read` command used "display" or "pretty" URLs, which are not supported by the `extractPageId` function.
-- **Fix:** Removed incorrect URL examples and clarified that only URLs with a `pageId` query parameter are supported.
-
-## Next Steps
-
-- Refer to [README.md](./README.md) for detailed usage instructions and advanced configuration.
-- For troubleshooting or to contribute, visit the project's GitHub repository at https://github.com/pchuri/confluence-cli.
-- If you encounter issues, open an issue or check the FAQ section in the documentation.