confluence-cli 1.19.0 → 1.21.0

package/bin/confluence.js

@@ -20,7 +20,7 @@ program
   .option('-d, --domain <domain>', 'Confluence domain')
   .option('-p, --api-path <path>', 'REST API path')
   .option('-a, --auth-type <type>', 'Authentication type (basic or bearer)')
-  .option('-e, --email <email>', 'Email for basic auth')
+  .option('-e, --email <email>', 'Email or username for basic auth')
   .option('-t, --token <token>', 'API token')
   .action(async (options) => {
     await initConfig(options);
@@ -140,6 +140,50 @@ program
     }
   });
 
+// Install skill command
+program
+  .command('install-skill')
+  .description('Copy Claude Code skill files into your project\'s .claude/skills/ directory')
+  .option('--dest <directory>', 'Target directory', './.claude/skills/confluence')
+  .option('-y, --yes', 'Skip confirmation prompt')
+  .action(async (options) => {
+    const fs = require('fs');
+    const path = require('path');
+
+    const skillSrc = path.join(__dirname, '..', '.claude', 'skills', 'confluence', 'SKILL.md');
+
+    if (!fs.existsSync(skillSrc)) {
+      console.error(chalk.red('Error: skill file not found in package. Try reinstalling confluence-cli.'));
+      process.exit(1);
+    }
+
+    const destDir = path.resolve(options.dest);
+    const destFile = path.join(destDir, 'SKILL.md');
+
+    if (fs.existsSync(destFile) && !options.yes) {
+      const { confirmed } = await inquirer.prompt([
+        {
+          type: 'confirm',
+          name: 'confirmed',
+          default: true,
+          message: `Overwrite existing skill file at ${destFile}?`
+        }
+      ]);
+
+      if (!confirmed) {
+        console.log(chalk.yellow('Cancelled.'));
+        return;
+      }
+    }
+
+    fs.mkdirSync(destDir, { recursive: true });
+    fs.copyFileSync(skillSrc, destFile);
+
+    console.log(chalk.green('✅ Skill installed successfully!'));
+    console.log(`Location: ${chalk.gray(destFile)}`);
+    console.log(chalk.yellow('Claude Code will now pick up confluence-cli knowledge from this file.'));
+  });
+
 // Create command
 program
   .command('create <title> <spaceKey>')
@@ -419,6 +463,7 @@ program
   .option('-p, --pattern <glob>', 'Filter attachments by filename (e.g., "*.png")')
   .option('-d, --download', 'Download matching attachments')
   .option('--dest <directory>', 'Directory to save downloads (default: current directory)', '.')
+  .option('-f, --format <format>', 'Output format (text, json)', 'text')
   .action(async (pageId, options) => {
     const analytics = new Analytics();
     try {
@@ -431,22 +476,47 @@ program
         throw new Error('Limit must be a positive number.');
       }
 
+      const format = (options.format || 'text').toLowerCase();
+      if (!['text', 'json'].includes(format)) {
+        throw new Error('Format must be one of: text, json');
+      }
+
       const attachments = await client.getAllAttachments(pageId, { maxResults });
       const filtered = pattern ? attachments.filter(att => client.matchesPattern(att.title, pattern)) : attachments;
 
       if (filtered.length === 0) {
-        console.log(chalk.yellow('No attachments found.'));
+        if (format === 'json') {
+          console.log(JSON.stringify({ attachmentCount: 0, attachments: [] }, null, 2));
+        } else {
+          console.log(chalk.yellow('No attachments found.'));
+        }
         analytics.track('attachments', true);
         return;
       }
 
-      console.log(chalk.blue(`Found ${filtered.length} attachment${filtered.length === 1 ? '' : 's'}:`));
-      filtered.forEach((att, index) => {
-        const sizeKb = att.fileSize ? `${Math.max(1, Math.round(att.fileSize / 1024))} KB` : 'unknown size';
-        const typeLabel = att.mediaType || 'unknown';
-        console.log(`${index + 1}. ${chalk.green(att.title)} (ID: ${att.id})`);
-        console.log(`   Type: ${chalk.gray(typeLabel)} • Size: ${chalk.gray(sizeKb)} • Version: ${chalk.gray(att.version)}`);
-      });
+      if (format === 'json' && !options.download) {
+        const output = {
+          attachmentCount: filtered.length,
+          attachments: filtered.map(att => ({
+            id: att.id,
+            title: att.title,
+            mediaType: att.mediaType || '',
+            fileSize: att.fileSize,
+            fileSizeFormatted: att.fileSize ? `${Math.max(1, Math.round(att.fileSize / 1024))} KB` : 'unknown size',
+            version: att.version,
+            downloadLink: att.downloadLink
+          }))
+        };
+        console.log(JSON.stringify(output, null, 2));
+      } else if (!options.download) {
+        console.log(chalk.blue(`Found ${filtered.length} attachment${filtered.length === 1 ? '' : 's'}:`));
+        filtered.forEach((att, index) => {
+          const sizeKb = att.fileSize ? `${Math.max(1, Math.round(att.fileSize / 1024))} KB` : 'unknown size';
+          const typeLabel = att.mediaType || 'unknown';
+          console.log(`${index + 1}. ${chalk.green(att.title)} (ID: ${att.id})`);
+          console.log(`   Type: ${chalk.gray(typeLabel)} • Size: ${chalk.gray(sizeKb)} • Version: ${chalk.gray(att.version)}`);
+        });
+      }
 
       if (options.download) {
         const fs = require('fs');
@@ -475,17 +545,28 @@ program
           writer.on('finish', resolve);
         });
 
-        let downloaded = 0;
+        const downloadResults = [];
         for (const attachment of filtered) {
           const targetPath = uniquePathFor(destDir, attachment.title);
-          // Pass the full attachment object so downloadAttachment can use downloadLink directly
           const dataStream = await client.downloadAttachment(pageId, attachment);
           await writeStream(dataStream, targetPath);
-          downloaded += 1;
-          console.log(`⬇️  ${chalk.green(attachment.title)} -> ${chalk.gray(targetPath)}`);
+          downloadResults.push({ title: attachment.title, id: attachment.id, savedTo: targetPath });
+          if (format !== 'json') {
+            console.log(`⬇️  ${chalk.green(attachment.title)} -> ${chalk.gray(targetPath)}`);
+          }
         }
 
-        console.log(chalk.green(`Downloaded ${downloaded} attachment${downloaded === 1 ? '' : 's'} to ${destDir}`));
+        if (format === 'json') {
+          const output = {
+            attachmentCount: filtered.length,
+            downloaded: downloadResults.length,
+            destination: destDir,
+            attachments: downloadResults
+          };
+          console.log(JSON.stringify(output, null, 2));
+        } else {
+          console.log(chalk.green(`Downloaded ${downloadResults.length} attachment${downloadResults.length === 1 ? '' : 's'} to ${destDir}`));
+        }
       }
 
       analytics.track('attachments', true);

package/lib/config.js

@@ -8,7 +8,7 @@ const CONFIG_DIR = path.join(os.homedir(), '.confluence-cli');
 const CONFIG_FILE = path.join(CONFIG_DIR, 'config.json');
 
 const AUTH_CHOICES = [
-  { name: 'Basic (email + API token)', value: 'basic' },
+  { name: 'Basic (credentials)', value: 'basic' },
   { name: 'Bearer token', value: 'bearer' }
 ];
 
@@ -91,7 +91,7 @@ const validateCliOptions = (options) => {
   // Check if basic auth is provided with email
   const normAuthType = options.authType ? normalizeAuthType(options.authType, Boolean(options.email)) : null;
   if (normAuthType === 'basic' && !options.email) {
-    errors.push('--email is required when using basic authentication');
+    errors.push('--email is required when using basic authentication (use your username for on-premise)');
   }
 
   return errors;
@@ -175,12 +175,12 @@ const promptForMissingValues = async (providedValues) => {
     questions.push({
       type: 'input',
       name: 'email',
-      message: 'Confluence email (used with API token):',
+      message: 'Email / username:',
       when: (responses) => {
         const authType = providedValues.authType || responses.authType;
         return authType === 'basic';
       },
-      validate: requiredInput('Email')
+      validate: requiredInput('Email / username')
     });
   }
 
@@ -189,8 +189,8 @@ const promptForMissingValues = async (providedValues) => {
     questions.push({
       type: 'password',
       name: 'token',
-      message: 'API Token:',
-      validate: requiredInput('API Token')
+      message: 'API token / password:',
+      validate: requiredInput('API token / password')
     });
   }
 
@@ -258,15 +258,15 @@ async function initConfig(cliOptions = {}) {
       {
         type: 'input',
         name: 'email',
-        message: 'Confluence email (used with API token):',
+        message: 'Email / username:',
         when: (responses) => responses.authType === 'basic',
-        validate: requiredInput('Email')
+        validate: requiredInput('Email / username')
       },
       {
         type: 'password',
         name: 'token',
-        message: 'API Token:',
-        validate: requiredInput('API Token')
+        message: 'API token / password:',
+        validate: requiredInput('API token / password')
       }
     ]);
 
@@ -351,8 +351,8 @@ async function initConfig(cliOptions = {}) {
 
 function getConfig() {
   const envDomain = process.env.CONFLUENCE_DOMAIN || process.env.CONFLUENCE_HOST;
-  const envToken = process.env.CONFLUENCE_API_TOKEN;
-  const envEmail = process.env.CONFLUENCE_EMAIL;
+  const envToken = process.env.CONFLUENCE_API_TOKEN || process.env.CONFLUENCE_PASSWORD;
+  const envEmail = process.env.CONFLUENCE_EMAIL || process.env.CONFLUENCE_USERNAME;
   const envAuthType = process.env.CONFLUENCE_AUTH_TYPE;
   const envApiPath = process.env.CONFLUENCE_API_PATH;
 
@@ -368,8 +368,8 @@ function getConfig() {
     }
 
     if (authType === 'basic' && !envEmail) {
-      console.error(chalk.red('❌ Basic authentication requires CONFLUENCE_EMAIL.'));
-      console.log(chalk.yellow('Set CONFLUENCE_EMAIL or switch to bearer auth by setting CONFLUENCE_AUTH_TYPE=bearer.'));
+      console.error(chalk.red('❌ Basic authentication requires CONFLUENCE_EMAIL or CONFLUENCE_USERNAME.'));
+      console.log(chalk.yellow('Set CONFLUENCE_EMAIL (or CONFLUENCE_USERNAME for on-premise) or switch to bearer auth by setting CONFLUENCE_AUTH_TYPE=bearer.'));
       process.exit(1);
     }
 
@@ -385,7 +385,7 @@ function getConfig() {
   if (!fs.existsSync(CONFIG_FILE)) {
     console.error(chalk.red('❌ No configuration found!'));
     console.log(chalk.yellow('Please run "confluence init" to set up your configuration.'));
-    console.log(chalk.gray('Or set environment variables: CONFLUENCE_DOMAIN, CONFLUENCE_API_TOKEN, CONFLUENCE_EMAIL, and optionally CONFLUENCE_API_PATH.'));
+    console.log(chalk.gray('Or set environment variables: CONFLUENCE_DOMAIN, CONFLUENCE_API_TOKEN (or CONFLUENCE_PASSWORD), CONFLUENCE_EMAIL (or CONFLUENCE_USERNAME), and optionally CONFLUENCE_API_PATH.'));
     process.exit(1);
   }
 
@@ -404,8 +404,8 @@ function getConfig() {
     }
 
     if (authType === 'basic' && !trimmedEmail) {
-      console.error(chalk.red('❌ Basic authentication requires an email address.'));
-      console.log(chalk.yellow('Please rerun "confluence init" to add your Confluence email.'));
+      console.error(chalk.red('❌ Basic authentication requires an email address or username.'));
+      console.log(chalk.yellow('Please rerun "confluence init" to add your Confluence email or username.'));
       process.exit(1);
     }
 

package/lib/confluence-client.js

@@ -42,7 +42,7 @@ class ConfluenceClient {
 
   buildBasicAuthHeader() {
     if (!this.email) {
-      throw new Error('Basic authentication requires an email address.');
+      throw new Error('Basic authentication requires an email address or username.');
     }
 
     const encodedCredentials = Buffer.from(`${this.email}:${this.token}`).toString('base64');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "confluence-cli",
-  "version": "1.19.0",
+  "version": "1.21.0",
   "description": "A command-line interface for Atlassian Confluence with page creation and editing capabilities",
   "main": "index.js",
   "bin": {
@@ -54,5 +54,10 @@
   "bugs": {
     "url": "https://github.com/pchuri/confluence-cli/issues"
   },
-  "homepage": "https://github.com/pchuri/confluence-cli#readme"
+  "homepage": "https://github.com/pchuri/confluence-cli#readme",
+  "files": [
+    "bin/",
+    "lib/",
+    ".claude/skills/"
+  ]
 }

package/.eslintrc.js

@@ -1,23 +0,0 @@
-module.exports = {
-  env: {
-    es2021: true,
-    node: true,
-    jest: true
-  },
-  extends: [
-    'eslint:recommended'
-  ],
-  parserOptions: {
-    ecmaVersion: 12,
-    sourceType: 'module'
-  },
-  rules: {
-    'indent': ['error', 2],
-    'linebreak-style': ['error', 'unix'],
-    'quotes': ['error', 'single'],
-    'semi': ['error', 'always'],
-    'no-unused-vars': ['error', { argsIgnorePattern: '^_' }],
-    'no-console': 'off',
-    'no-process-exit': 'off'
-  }
-};

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,34 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: '[BUG] '
-labels: bug
-assignees: ''
-
----
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Run command '...'
-2. See error
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**Environment (please complete the following information):**
- - OS: [e.g. macOS, Windows, Linux]
- - Node.js version: [e.g. 18.17.0]
- - confluence-cli version: [e.g. 1.0.0]
- - Confluence version: [e.g. Cloud, Server 8.5]
-
-**Additional context**
-Add any other context about the problem here.
-
-**Error logs**
-If applicable, add error logs or stack traces.

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,26 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-title: '[FEATURE] '
-labels: enhancement
-assignees: ''
-
----
-
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
-
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
-
-**Use case**
-Describe how this feature would be used and who would benefit from it.
-
-**Additional context**
-Add any other context or screenshots about the feature request here.
-
-**Implementation suggestions**
-If you have ideas about how this could be implemented, please share them here.

package/.github/ISSUE_TEMPLATE/feedback.md

@@ -1,37 +0,0 @@
----
-name: General Feedback
-about: Share your thoughts, suggestions, or general feedback about confluence-cli
-title: '[FEEDBACK] '
-labels: feedback, enhancement
-assignees: ''
-
----
-
-## 📝 Your Feedback
-
-Thank you for taking the time to share your thoughts about confluence-cli!
-
-### What did you try to accomplish?
-A clear description of what you were trying to do with confluence-cli.
-
-### How was your experience?
-Tell us about your experience using the tool:
-- What worked well?
-- What was confusing or difficult?
-- What features are you missing?
-
-### Your environment
-- OS: [e.g. macOS, Windows, Linux]
-- Node.js version: [e.g. 18.17.0]
-- confluence-cli version: [e.g. 1.0.1]
-- Confluence instance: [e.g. Cloud, Server, Data Center]
-
-### Feature requests or improvements
-What would make confluence-cli more useful for you?
-
-### Additional context
-Anything else you'd like to share about your experience with confluence-cli?
-
----
-
-💡 **Tip**: You can also join our [Discussions](https://github.com/pchuri/confluence-cli/discussions) for general questions and community chat!

package/.github/pull_request_template.md

@@ -1,31 +0,0 @@
-## Pull Request Template
-
-### Description
-Brief description of what this PR does.
-
-### Type of Change
-- [ ] Bug fix (non-breaking change which fixes an issue)
-- [ ] New feature (non-breaking change which adds functionality)
-- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
-- [ ] Documentation update
-- [ ] Performance improvement
-- [ ] Code refactoring
-
-### 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 commented my code, particularly in hard-to-understand areas
-- [ ] 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
-
-### Screenshots (if applicable)
-Add screenshots to help explain your changes.
-
-### Additional Context
-Add any other context about the pull request here.

package/.github/workflows/ci.yml

@@ -1,68 +0,0 @@
-name: CI/CD
-
-on:
-  push:
-    branches: [ main, develop ]
-  pull_request:
-    branches: [ main ]
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    
-    strategy:
-      matrix:
-        node-version: [16.x, 18.x, 20.x]
-    
-    steps:
-    - uses: actions/checkout@v3
-    
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v3
-      with:
-        node-version: ${{ matrix.node-version }}
-        cache: 'npm'
-    
-    - run: npm ci
-    - run: npm run lint
-    - run: npm test
-    
-  security:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v3
-    - run: npm ci
-    - name: Run npm audit (production only)
-      run: npm audit --audit-level moderate --omit=dev
-
-  publish:
-    needs: [test, security]
-    runs-on: ubuntu-latest
-    if: github.ref == 'refs/heads/main'
-    permissions:
-      contents: write
-      issues: write
-      pull-requests: write
-    
-    steps:
-    - uses: actions/checkout@v3
-      with:
-        fetch-depth: 0
-        token: ${{ secrets.GITHUB_TOKEN }}
-    
-    - name: Setup Node.js
-      uses: actions/setup-node@v3
-      with:
-        node-version: '18'
-        registry-url: 'https://registry.npmjs.org'
-      env:
-        NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-    
-    - run: npm ci
-    - run: npm test
-    
-    - name: Semantic Release
-      uses: cycjimmy/semantic-release-action@v3
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.releaserc

@@ -1,17 +0,0 @@
-{
-  "branches": ["main"],
-  "plugins": [
-    "@semantic-release/commit-analyzer",
-    "@semantic-release/release-notes-generator",
-    "@semantic-release/changelog",
-    "@semantic-release/npm",
-    "@semantic-release/github",
-    [
-      "@semantic-release/git",
-      {
-        "assets": ["package.json", "CHANGELOG.md"],
-        "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
-      }
-    ]
-  ]
-}