{"_id":"@aashari/nodejs-confluence-export","_rev":"3-1b89d44f9c5e0d202b3e6dd3fdb7bf61","name":"@aashari/nodejs-confluence-export","dist-tags":{"latest":"1.1.2"},"versions":{"1.1.0":{"name":"@aashari/nodejs-confluence-export","version":"1.1.0","keywords":["confluence","export","cli","typescript","nodejs","atlassian"],"author":{"name":"Andi Ashari"},"license":"ISC","_id":"@aashari/nodejs-confluence-export@1.1.0","maintainers":[{"name":"aashari","email":"mq.aashari@gmail.com"}],"homepage":"https://github.com/aashari/nodejs-confluence-export#readme","bugs":{"url":"https://github.com/aashari/nodejs-confluence-export/issues"},"bin":{"confluence-export":"dist/index.js"},"dist":{"shasum":"ab226411caf21d785790e9e54e396aa3778b3b77","tarball":"https://registry.npmjs.org/@aashari/nodejs-confluence-export/-/nodejs-confluence-export-1.1.0.tgz","fileCount":52,"integrity":"sha512-R5QHyyPsWaX4glBM8FqaWMtaJShWHppmd2iL5vd5YB4aQjFB/btT4M2plJdmE05nwCrh01a8ASYoZPtatS/gkg==","signatures":[{"sig":"MEQCIALBqCQZec8e4068fdfxJlfx8LyioffCa3BWuWGOhDlMAiAv6Q5p0JHVU0UxOQ6CzAfeOoHnmAL54zsrn9BkgZW4hA==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":139530},"jest":{"preset":"ts-jest","testMatch":["**/src/**/*.test.ts"],"transform":{"^.+\\.tsx?$":["ts-jest",{"useESM":true}]},"testEnvironment":"node","moduleNameMapper":{"(.*)\\.(js|jsx)$":"$1"},"coverageReporters":["text","lcov","json-summary"],"collectCoverageFrom":["src/**/*.ts","!src/**/*.test.ts","!src/**/*.spec.ts"],"moduleFileExtensions":["ts","tsx","js","jsx","json","node"],"extensionsToTreatAsEsm":[".ts"],"coveragePathIgnorePatterns":["/node_modules/","/dist/","/coverage/"]},"main":"dist/index.js","type":"commonjs","types":"dist/index.d.ts","engines":{"node":">=18.0.0"},"gitHead":"335452ddae3d0c201e823f5ece2e3a30384f39e6","scripts":{"lint":"eslint \"{src,test}/**/*.ts\" --fix","test":"NODE_ENV=test jest","build":"tsc","format":"prettier --write \"src/**/*.ts\" \"test/**/*.ts\"","dev:cli":"DEBUG=true npm run build && DEBUG=true node dist/index.js","prepare":"npm run build","tsprune":"ts-prune --error","prebuild":"rimraf dist","test:cov":"NODE_ENV=test jest --coverage","start:cli":"npm run build && node dist/index.js","typecheck":"tsc --noEmit","test:watch":"NODE_ENV=test jest --watch"},"_npmUser":{"name":"aashari","email":"mq.aashari@gmail.com"},"repository":{"url":"git+https://github.com/aashari/nodejs-confluence-export.git","type":"git"},"_npmVersion":"10.9.2","description":"CLI tool to export Confluence pages by space with flexible filtering options.","directories":{"example":"examples"},"_nodeVersion":"22.15.0","dependencies":{"zod":"^3.22.4","dotenv":"^16.4.5","js-yaml":"^4.1.0","fs-extra":"^11.2.0","turndown":"^7.1.2","commander":"^12.0.0","node-fetch":"^3.3.2","fast-safe-stringify":"^2.1.1","@commander-js/extra-typings":"^12.0.1"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^29.7.0","eslint":"^8.57.0","rimraf":"^5.0.5","ts-jest":"^29.1.2","ts-node":"^10.9.2","prettier":"^3.2.5","ts-prune":"^0.10.3","typescript":"^5.4.3","@types/jest":"^29.5.12","@types/node":"^20.12.2","@types/fs-extra":"^11.0.4","@types/turndown":"^5.0.4","typescript-eslint":"^7.18.0","eslint-plugin-jest":"^27.9.0","@semantic-release/git":"^10.0.1","eslint-config-prettier":"^9.1.0","eslint-plugin-prettier":"^5.1.3","@typescript-eslint/parser":"^7.4.0","@semantic-release/changelog":"^6.0.3","@typescript-eslint/eslint-plugin":"^7.4.0"},"_npmOperationalInternal":{"tmp":"tmp/nodejs-confluence-export_1.1.0_1746596424010_0.7455959588773071","host":"s3://npm-registry-packages-npm-production"}},"1.1.1":{"name":"@aashari/nodejs-confluence-export","version":"1.1.1","keywords":["confluence","export","cli","typescript","nodejs","atlassian"],"author":{"name":"Andi Ashari"},"license":"ISC","_id":"@aashari/nodejs-confluence-export@1.1.1","maintainers":[{"name":"aashari","email":"mq.aashari@gmail.com"}],"homepage":"https://github.com/aashari/nodejs-confluence-export#readme","bugs":{"url":"https://github.com/aashari/nodejs-confluence-export/issues"},"bin":{"confluence-export":"dist/index.js"},"dist":{"shasum":"29a895de3d99cb08e612f1e37d82d308710fd4b5","tarball":"https://registry.npmjs.org/@aashari/nodejs-confluence-export/-/nodejs-confluence-export-1.1.1.tgz","fileCount":53,"integrity":"sha512-vPo2y4ZvHIj9t7RIHOJaG/sQ0sC4SPNUQ7C8UozC9eOnCoowVobMX/60MMeLGvDD4X0FvodbbxXb3kxUWl0feQ==","signatures":[{"sig":"MEYCIQDCRjfVCOg01+udDsZXHOm8ym2jk4bNhUTT0IM25+BRBAIhAMbwLNioVvsH1RcgsgzH6GpvvBVk1dJHf/qussegtmLK","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":143570},"jest":{"preset":"ts-jest","testMatch":["**/src/**/*.test.ts"],"transform":{"^.+\\.tsx?$":["ts-jest",{"useESM":true}]},"testEnvironment":"node","moduleNameMapper":{"(.*)\\.(js|jsx)$":"$1"},"coverageReporters":["text","lcov","json-summary"],"collectCoverageFrom":["src/**/*.ts","!src/**/*.test.ts","!src/**/*.spec.ts"],"moduleFileExtensions":["ts","tsx","js","jsx","json","node"],"extensionsToTreatAsEsm":[".ts"],"coveragePathIgnorePatterns":["/node_modules/","/dist/","/coverage/"]},"main":"dist/index.js","type":"commonjs","types":"dist/index.d.ts","engines":{"node":">=18.0.0"},"gitHead":"205053884a347c6885808f34c31e08ea6eaa01fd","scripts":{"lint":"eslint \"{src,test}/**/*.ts\" --fix","test":"NODE_ENV=test jest","build":"tsc","format":"prettier --write \"src/**/*.ts\" \"test/**/*.ts\"","dev:cli":"DEBUG=true npm run build && DEBUG=true node dist/index.js","prepare":"npm run build","tsprune":"ts-prune --error","prebuild":"rimraf dist","test:cov":"NODE_ENV=test jest --coverage","start:cli":"npm run build && node dist/index.js","typecheck":"tsc --noEmit","test:watch":"NODE_ENV=test jest --watch","publish:npm":"npm publish","update:deps":"npx npm-check-updates -u && npm install --legacy-peer-deps","update:check":"npx npm-check-updates","update:version":"node scripts/update-version.js"},"_npmUser":{"name":"aashari","email":"mq.aashari@gmail.com"},"repository":{"url":"git+https://github.com/aashari/nodejs-confluence-export.git","type":"git"},"_npmVersion":"10.9.2","description":"CLI tool to export Confluence pages by space with flexible filtering options.","directories":{"example":"examples"},"_nodeVersion":"22.15.0","dependencies":{"zod":"^3.22.4","dotenv":"^16.4.5","js-yaml":"^4.1.0","fs-extra":"^11.2.0","turndown":"^7.1.2","commander":"^12.0.0","node-fetch":"^3.3.2","fast-safe-stringify":"^2.1.1","@commander-js/extra-typings":"^12.0.1"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^29.7.0","eslint":"^8.57.0","rimraf":"^5.0.5","ts-jest":"^29.1.2","ts-node":"^10.9.2","prettier":"^3.2.5","ts-prune":"^0.10.3","typescript":"^5.4.3","@types/jest":"^29.5.12","@types/node":"^20.12.2","@types/fs-extra":"^11.0.4","@types/turndown":"^5.0.4","typescript-eslint":"^7.18.0","eslint-plugin-jest":"^27.9.0","@semantic-release/git":"^10.0.1","eslint-config-prettier":"^9.1.0","eslint-plugin-prettier":"^5.1.3","@typescript-eslint/parser":"^7.4.0","@semantic-release/changelog":"^6.0.3","@typescript-eslint/eslint-plugin":"^7.4.0"},"_npmOperationalInternal":{"tmp":"tmp/nodejs-confluence-export_1.1.1_1746597130446_0.38448377532907774","host":"s3://npm-registry-packages-npm-production"}},"1.1.2":{"name":"@aashari/nodejs-confluence-export","version":"1.1.2","description":"CLI tool to export Confluence pages by space with flexible filtering options.","main":"dist/index.js","types":"dist/index.d.ts","type":"commonjs","repository":{"type":"git","url":"git+https://github.com/aashari/nodejs-confluence-export.git"},"bin":{"confluence-export":"dist/index.js"},"scripts":{"prepare":"npm run build","prebuild":"rimraf dist","build":"tsc","format":"prettier --write \"src/**/*.ts\" \"test/**/*.ts\"","lint":"eslint \"{src,test}/**/*.ts\" --fix","test":"NODE_ENV=test jest","test:watch":"NODE_ENV=test jest --watch","test:cov":"NODE_ENV=test jest --coverage","dev:cli":"DEBUG=true npm run build && DEBUG=true node dist/index.js","start:cli":"npm run build && node dist/index.js","typecheck":"tsc --noEmit","tsprune":"ts-prune --error","update:check":"npx npm-check-updates","update:deps":"npx npm-check-updates -u && npm install --legacy-peer-deps","update:version":"node scripts/update-version.js","publish:npm":"npm publish"},"keywords":["confluence","export","cli","typescript","nodejs","atlassian"],"author":{"name":"Andi Ashari"},"license":"ISC","devDependencies":{"@semantic-release/changelog":"^6.0.3","@semantic-release/exec":"^7.0.3","@semantic-release/git":"^10.0.1","@semantic-release/github":"^11.0.2","@semantic-release/npm":"^12.0.1","@types/fs-extra":"^11.0.4","@types/jest":"^29.5.14","@types/node":"^22.15.14","@types/turndown":"^5.0.5","@typescript-eslint/eslint-plugin":"^8.32.0","@typescript-eslint/parser":"^8.32.0","eslint":"^9.26.0","eslint-config-prettier":"^10.1.2","eslint-plugin-jest":"^28.11.0","eslint-plugin-prettier":"^5.4.0","jest":"^29.7.0","prettier":"^3.5.3","rimraf":"^6.0.1","ts-jest":"^29.3.2","ts-node":"^10.9.2","ts-prune":"^0.10.3","typescript":"^5.8.3","typescript-eslint":"^8.32.0","semantic-release":"^24.2.3"},"publishConfig":{"registry":"https://registry.npmjs.org/","access":"public"},"dependencies":{"@commander-js/extra-typings":"^13.1.0","commander":"^13.1.0","dotenv":"^16.5.0","fast-safe-stringify":"^2.1.1","fs-extra":"^11.3.0","js-yaml":"^4.1.0","node-fetch":"^3.3.2","turndown":"^7.2.0","zod":"^3.24.4"},"directories":{"example":"examples"},"jest":{"preset":"ts-jest","testEnvironment":"node","testMatch":["**/src/**/*.test.ts"],"collectCoverageFrom":["src/**/*.ts","!src/**/*.test.ts","!src/**/*.spec.ts"],"coveragePathIgnorePatterns":["/node_modules/","/dist/","/coverage/"],"coverageReporters":["text","lcov","json-summary"],"transform":{"^.+\\.tsx?$":["ts-jest",{"useESM":true}]},"moduleNameMapper":{"(.*)\\.(js|jsx)$":"$1"},"extensionsToTreatAsEsm":[".ts"],"moduleFileExtensions":["ts","tsx","js","jsx","json","node"]},"engines":{"node":">=18.0.0"},"_id":"@aashari/nodejs-confluence-export@1.1.2","gitHead":"1472b6c6c779ee77fdb066a73122adb64bb1c398","bugs":{"url":"https://github.com/aashari/nodejs-confluence-export/issues"},"homepage":"https://github.com/aashari/nodejs-confluence-export#readme","_nodeVersion":"22.15.0","_npmVersion":"10.9.2","dist":{"integrity":"sha512-3We+b4cq7fcb2roO8QiQRPTNZ/6YMsxu+llMWxQ77Iwrc+IVWkPgGjiI2PlkmyIPU7QZshVyEnJQ88IqXk9GzA==","shasum":"41dc900d235126e2b8244c612dbb1cdb49a3a6ad","tarball":"https://registry.npmjs.org/@aashari/nodejs-confluence-export/-/nodejs-confluence-export-1.1.2.tgz","fileCount":53,"unpackedSize":144525,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQCwNuUucktQ6LN9yLNy5SzFGW4QJi2FaT/67YlZ4kpj3AIgAP4K0cY6QCSus6jDNFkMpuLq4TxCgqvJc4NsRGc3Xo0="}]},"_npmUser":{"name":"aashari","email":"mq.aashari@gmail.com"},"maintainers":[{"name":"aashari","email":"mq.aashari@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/nodejs-confluence-export_1.1.2_1746598153953_0.7874762530580168"},"_hasShrinkwrap":false}},"time":{"created":"2025-05-07T05:40:23.901Z","modified":"2025-05-07T06:09:14.329Z","1.1.0":"2025-05-07T05:40:24.211Z","1.1.1":"2025-05-07T05:52:10.673Z","1.1.2":"2025-05-07T06:09:14.146Z"},"bugs":{"url":"https://github.com/aashari/nodejs-confluence-export/issues"},"author":{"name":"Andi Ashari"},"license":"ISC","homepage":"https://github.com/aashari/nodejs-confluence-export#readme","keywords":["confluence","export","cli","typescript","nodejs","atlassian"],"repository":{"type":"git","url":"git+https://github.com/aashari/nodejs-confluence-export.git"},"description":"CLI tool to export Confluence pages by space with flexible filtering options.","maintainers":[{"name":"aashari","email":"mq.aashari@gmail.com"}],"readme":"# Confluence Export CLI\n\nA powerful Node.js/TypeScript command-line tool for exporting Confluence pages with advanced filtering capabilities, preserving page relationships and content formatting.\n\n---\n\n# Overview\n\nThis CLI tool enables you to export entire Confluence spaces to your local filesystem while maintaining hierarchical structure and page relationships. It converts Confluence's complex storage format into clean Markdown or HTML files with proper formatting for macros, tables, code blocks, and other Confluence elements.\n\n## Key Features\n\n- **Complete Space Export**: Export an entire Confluence space with a single command\n- **Hierarchical Organization**: Preserves page ancestry and relationships in folder structure\n- **Flexible Filtering**: Exclude specific pages or entire branches with parent-based or title pattern filters\n- **Content Preservation**: Properly renders Confluence macros, tables, code blocks, info/note panels, and more\n- **Metadata Retention**: Includes page metadata (created date, updated date, path/breadcrumbs) in exports\n- **Progress Indicators**: Shows real-time progress during export with clear summaries\n\n---\n\n# Getting Started\n\n## Prerequisites\n\n- **Node.js** (>=18.x): [Download](https://nodejs.org/)\n- **Confluence Cloud Account** with API access\n\n---\n\n## Step 1: Get Your Atlassian API Token\n\n1. Go to your Atlassian API token management page:\n   [https://id.atlassian.com/manage-profile/security/api-tokens](https://id.atlassian.com/manage-profile/security/api-tokens)\n2. Click **Create API token**.\n3. Give it a descriptive **Label** (e.g., `confluence-export-cli`).\n4. Click **Create**.\n5. **Copy the generated API token** immediately. You won't be able to see it again.\n\n---\n\n## Step 2: Configure Credentials\n\n### Method A: Environment Variables\n\nSet these environment variables:\n\n```bash\nexport ATLASSIAN_SITE_NAME=\"yourcompany\"        # For yourcompany.atlassian.net\nexport ATLASSIAN_USER_EMAIL=\"your.email@example.com\"\nexport ATLASSIAN_API_TOKEN=\"your-api-token\"\n```\n\n### Method B: .env File\n\nCreate a `.env` file in your project directory:\n\n```\nATLASSIAN_SITE_NAME=yourcompany\nATLASSIAN_USER_EMAIL=your.email@example.com\nATLASSIAN_API_TOKEN=your-api-token\n```\n\n---\n\n# Usage Examples\n\n## Quick Use with `npx`\n\nExport a space to the default output directory (`./output`):\n\n```bash\nnpx -y @aashari/nodejs-confluence-export export --space SPACEKEY\n```\n\nUsing inline environment variables:\n\n```bash\nATLASSIAN_SITE_NAME=yourcompany ATLASSIAN_USER_EMAIL=your.email@example.com ATLASSIAN_API_TOKEN=your-api-token npx -y @aashari/nodejs-confluence-export export --space SPACEKEY\n```\n\n## Install Globally\n\n```bash\nnpm install -g @aashari/nodejs-confluence-export\n```\n\nThen run directly:\n\n```bash\nconfluence-export export --space SPACEKEY\n```\n\n## Custom Output Directory\n\n```bash\nnpx -y @aashari/nodejs-confluence-export export --space SPACEKEY --output-dir ./my-exports\n```\n\n## Choose Format (Markdown or HTML)\n\n```bash\nnpx -y @aashari/nodejs-confluence-export export --space SPACEKEY --format html\n```\n\n## Filter Pages to Exclude\n\nExclude a specific page and all its children:\n\n```bash\nnpx -y @aashari/nodejs-confluence-export export --space SPACEKEY --ignore parent:12345678\n```\n\nExclude pages matching a title pattern:\n\n```bash\nnpx -y @aashari/nodejs-confluence-export export --space SPACEKEY --ignore title:DRAFT\n```\n\nUse multiple filters:\n\n```bash\nnpx -y @aashari/nodejs-confluence-export export --space SPACEKEY --ignore parent:12345678 --ignore title:\"Internal Only\"\n```\n\n---\n\n# Command Reference\n\n## Main Commands\n\n```\nconfluence-export export [options]  Export Confluence pages from a specified space\n```\n\n## Export Options\n\n- `-s, --space <spaceKey>`: (Required) The key of the Confluence space to export\n- `-o, --output-dir <path>`: Directory to save exported files (default: `./output`)\n- `-f, --format <format>`: Export format - markdown or html (default: `markdown`)\n- `--ignore <filter...>`: Pages to ignore. Format: \"parent:ID\" to ignore a page and all children, or \"title:REGEX\" to ignore pages matching regex pattern. Can be used multiple times.\n\n---\n\n# Output Structure\n\nThe exported content will be organized as follows:\n\n```\noutput/\n├── space-name/\n│   ├── page-title-1/\n│   │   ├── child-page-1.md\n│   │   └── child-page-2.md\n│   ├── page-title-2/\n│   │   └── ...\n│   └── ...\n└── ...\n```\n\nEach Markdown/HTML file includes:\n\n1. Title as heading\n2. Metadata section with:\n    - Path/breadcrumbs\n    - Created date\n    - Updated date\n3. Page content with properly rendered Confluence elements\n4. Footer with export timestamp\n\n---\n\n# Troubleshooting\n\nIf you encounter issues with the export:\n\n1. Verify your Atlassian credentials are correct\n2. Ensure you have appropriate permissions for the space\n3. Check for rate limiting if exporting large spaces\n4. Use the `DEBUG=true` environment variable for detailed logs:\n\n```bash\nDEBUG=true npx -y @aashari/nodejs-confluence-export export --space SPACEKEY\n```\n\n---\n\n# Development\n\n- Build: `npm run build`\n- Test: `npm test`\n- Format code: `npm run format`\n- Lint code: `npm run lint`\n\n---\n\n# License\n\nISC\n","readmeFilename":"README.md"}