{"_id":"@pdfmonkey/cli","_rev":"7-0f687ba53ec48516a6c37280fcd2fa9b","name":"@pdfmonkey/cli","dist-tags":{"next":"1.1.0-rc.0","latest":"2.1.0"},"versions":{"1.0.0":{"name":"@pdfmonkey/cli","version":"1.0.0","keywords":["PDFMonkey","PDF","CLI","automation","tools"],"author":{"name":"Simon Courtois"},"license":"MIT","_id":"@pdfmonkey/cli@1.0.0","maintainers":[{"name":"tiny-monkey","email":"accounts@pdfmonkey.io"}],"homepage":"https://pdfmonkey.io","bugs":{"url":"https://github.com/pdfmonkey/pdfmonkey-cli/issues"},"bin":{"pdfmonkey":"bin/index.js"},"dist":{"shasum":"66a578a5255bf29da588cc698f8183f09c8d3484","tarball":"https://registry.npmjs.org/@pdfmonkey/cli/-/cli-1.0.0.tgz","fileCount":13,"integrity":"sha512-JBKJeme6gE1/sbHSrV5z98uXmKd9/oyXyBZKU6Xx4p9LrizI2jH1LhNAb80kFhGaQkNO9AI708zCfDXMmBb6mQ==","signatures":[{"sig":"MEQCICHNGvXX8r+LKCE8HnSSQ6pGM+YGSCeq7VHnTWSjwKLvAiBZr+k+TnahH5f4nI5S5ipuoHFv3govdxsWHjBxZ4Q16A==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@pdfmonkey%2fcli@1.0.0","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":23278},"main":"index.js","node":">=18","type":"module","gitHead":"b7ca22b938a9a196a474dbe7a82a2e14d2b0ed72","scripts":{"lint":"eslint .","format":"prettier --write .","prepare":"husky","lint:fix":"eslint . --fix","format:check":"prettier --check ."},"_npmUser":{"name":"tiny-monkey","email":"accounts@pdfmonkey.io"},"repository":{"url":"git+https://github.com/pdfmonkey/pdfmonkey-cli.git","type":"git"},"_npmVersion":"10.9.2","description":"A CLI tool to edit your PDFMonkey template locally with your favorite tools.","directories":{},"lint-staged":{"*.{js,jsx,ts,tsx}":["eslint --fix","prettier --write"]},"_nodeVersion":"22.13.0","dependencies":{"diff":"^7.0.0","open":"^10.1.0","chalk":"^5.4.1","chokidar":"^4.0.3","commander":"^13.0.0","livereload":"^0.9.3","@clack/prompts":"^0.9.1"},"publishConfig":{"access":"public","provenance":true},"_hasShrinkwrap":false,"devDependencies":{"husky":"^9.1.7","eslint":"^9.18.0","globals":"^15.14.0","prettier":"^3.4.2","@eslint/js":"^9.18.0","lint-staged":"^15.4.1","eslint-config-prettier":"^10.0.1","eslint-plugin-prettier":"^5.2.2"},"_npmOperationalInternal":{"tmp":"tmp/cli_1.0.0_1737722020871_0.6585303625487084","host":"s3://npm-registry-packages-npm-production"}},"1.0.1":{"name":"@pdfmonkey/cli","version":"1.0.1","keywords":["PDFMonkey","PDF","CLI","automation","tools"],"author":{"name":"Simon Courtois"},"license":"MIT","_id":"@pdfmonkey/cli@1.0.1","maintainers":[{"name":"tiny-monkey","email":"accounts@pdfmonkey.io"}],"homepage":"https://pdfmonkey.io","bugs":{"url":"https://github.com/pdfmonkey/pdfmonkey-cli/issues"},"bin":{"pdfmonkey":"bin/index.js"},"dist":{"shasum":"a953df4f4f9fe1fe96da510a25e21a8850e08861","tarball":"https://registry.npmjs.org/@pdfmonkey/cli/-/cli-1.0.1.tgz","fileCount":13,"integrity":"sha512-foNPwPC9ZigxTYsL8iFrWWn/b0E//xsmfIwzwsS2XQOdcOZJwUZctTuDylsq4pq+anVu5meopZdLz5sIvlHr2w==","signatures":[{"sig":"MEUCIQC66kZI6gBbEphz+vIPfG4jp2JwEntlWMEs1NWuRMiaFAIgdC4D/XzP3R9TjAZ8y/Hi0xRg2DdyImI//wXSmx6mWxw=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@pdfmonkey%2fcli@1.0.1","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":23427},"main":"index.js","node":">=18","type":"module","gitHead":"3fd53e0fcecfe53e9a8e496e74c07cfe9cb3618a","scripts":{"lint":"eslint .","format":"prettier --write .","prepare":"husky","lint:fix":"eslint . --fix","format:check":"prettier --check ."},"_npmUser":{"name":"tiny-monkey","email":"accounts@pdfmonkey.io"},"repository":{"url":"git+https://github.com/pdfmonkey/pdfmonkey-cli.git","type":"git"},"_npmVersion":"10.9.2","description":"A CLI tool to edit your PDFMonkey template locally with your favorite tools.","directories":{},"lint-staged":{"*.{js,jsx,ts,tsx}":["eslint --fix","prettier --write"]},"_nodeVersion":"22.13.0","dependencies":{"diff":"^7.0.0","open":"^10.1.0","chalk":"^5.4.1","chokidar":"^4.0.3","commander":"^13.0.0","livereload":"^0.9.3","@clack/prompts":"^0.9.1"},"publishConfig":{"access":"public","provenance":true},"_hasShrinkwrap":false,"devDependencies":{"husky":"^9.1.7","eslint":"^9.18.0","globals":"^15.14.0","prettier":"^3.4.2","@eslint/js":"^9.18.0","lint-staged":"^15.4.1","eslint-config-prettier":"^10.0.1","eslint-plugin-prettier":"^5.2.2"},"_npmOperationalInternal":{"tmp":"tmp/cli_1.0.1_1737722896774_0.47133265879716624","host":"s3://npm-registry-packages-npm-production"}},"1.0.2":{"name":"@pdfmonkey/cli","version":"1.0.2","keywords":["PDFMonkey","PDF","CLI","automation","tools"],"author":{"name":"Simon Courtois"},"license":"MIT","_id":"@pdfmonkey/cli@1.0.2","maintainers":[{"name":"tiny-monkey","email":"accounts@pdfmonkey.io"}],"homepage":"https://pdfmonkey.io","bugs":{"url":"https://github.com/pdfmonkey/pdfmonkey-cli/issues"},"bin":{"pdfmonkey":"bin/index.js"},"dist":{"shasum":"c45b8601356ef1c276836f236d5569631563dbe9","tarball":"https://registry.npmjs.org/@pdfmonkey/cli/-/cli-1.0.2.tgz","fileCount":13,"integrity":"sha512-X2uYGqm56tvP24fXpE2YIZUIqAeOhMJjFvCRWIhXelSLmf8CJFoQP1suU5VGlHJr0nUunI5PKa/taXkgBCP9OA==","signatures":[{"sig":"MEYCIQD8EsQFirGAuz4yXCF7x1HkwhJEYqwDX9t+2fFwgCDDBgIhALx940QOKkH6IK1gNwbIPHDhs89cInb62A6ZdqCewat1","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@pdfmonkey%2fcli@1.0.2","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":23428},"main":"index.js","node":">=18","type":"module","gitHead":"777247052dd8403b80f5a5f78d7b77fafc521ef5","scripts":{"lint":"eslint .","format":"prettier --write .","prepare":"husky","lint:fix":"eslint . --fix","format:check":"prettier --check ."},"_npmUser":{"name":"tiny-monkey","email":"accounts@pdfmonkey.io"},"repository":{"url":"git+https://github.com/pdfmonkey/pdfmonkey-cli.git","type":"git"},"_npmVersion":"10.9.2","description":"A CLI tool to edit your PDFMonkey template locally with your favorite tools.","directories":{},"lint-staged":{"*.{js,jsx,ts,tsx}":["eslint --fix","prettier --write"]},"_nodeVersion":"22.13.0","dependencies":{"diff":"^7.0.0","open":"^10.1.0","chalk":"^5.4.1","chokidar":"^4.0.3","commander":"^13.0.0","livereload":"^0.9.3","@clack/prompts":"^0.9.1"},"publishConfig":{"access":"public","provenance":true},"_hasShrinkwrap":false,"devDependencies":{"husky":"^9.1.7","eslint":"^9.18.0","globals":"^15.14.0","prettier":"^3.4.2","@eslint/js":"^9.18.0","lint-staged":"^15.4.1","eslint-config-prettier":"^10.0.1","eslint-plugin-prettier":"^5.2.2"},"_npmOperationalInternal":{"tmp":"tmp/cli_1.0.2_1737724080225_0.27981441782898564","host":"s3://npm-registry-packages-npm-production"}},"1.1.0-rc.0":{"name":"@pdfmonkey/cli","version":"1.1.0-rc.0","keywords":["PDFMonkey","PDF","CLI","automation","tools"],"author":{"name":"Simon Courtois"},"license":"MIT","_id":"@pdfmonkey/cli@1.1.0-rc.0","maintainers":[{"name":"tiny-monkey","email":"accounts@pdfmonkey.io"}],"homepage":"https://pdfmonkey.io","bugs":{"url":"https://github.com/pdfmonkey/pdfmonkey-cli/issues"},"bin":{"pdfmonkey":"bin/index.js"},"dist":{"shasum":"2b1db8fd1b6789acc456b765bb907318c41ca3e9","tarball":"https://registry.npmjs.org/@pdfmonkey/cli/-/cli-1.1.0-rc.0.tgz","fileCount":22,"integrity":"sha512-UdFBco/G38ZdbXPnbvZ/bjZwTPVtFIOkcw9uahpe5+7Xrj0l5HU3xVRgcUBm8zA2kodYXoHb+hKVdLR91RerSA==","signatures":[{"sig":"MEUCIQCxKvV19ec3HFpcrTU4kBVrvt9mRswbjOK0ouawkzyq1AIgCFcEjyZDBOASQGPPejitdNkkrttQh4WfMzGRrXlPFQo=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@pdfmonkey%2fcli@1.1.0-rc.0","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":57383},"main":"index.js","node":">=18","type":"module","gitHead":"36446b39d84e54963fa4433c29ebe7d0718f8759","scripts":{"lint":"eslint .","format":"prettier --write .","prepare":"husky","lint:fix":"eslint . --fix","format:check":"prettier --check ."},"_npmUser":{"name":"tiny-monkey","email":"accounts@pdfmonkey.io"},"repository":{"url":"git+https://github.com/pdfmonkey/pdfmonkey-cli.git","type":"git"},"_npmVersion":"10.9.2","description":"A CLI tool to edit your PDFMonkey template locally with your favorite tools.","directories":{},"lint-staged":{"*.{js,jsx,ts,tsx}":["eslint --fix","prettier --write"]},"_nodeVersion":"22.15.0","dependencies":{"diff":"^7.0.0","open":"^10.1.0","chalk":"^5.4.1","chokidar":"^4.0.3","commander":"^13.0.0","livereload":"^0.9.3","shell-escape":"^0.2.0","@clack/prompts":"^0.9.1"},"publishConfig":{"access":"public","provenance":true},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"husky":"^9.1.7","eslint":"^9.18.0","globals":"^15.14.0","prettier":"^3.4.2","@eslint/js":"^9.18.0","lint-staged":"^15.4.1","eslint-config-prettier":"^10.0.1","eslint-plugin-prettier":"^5.2.2"},"_npmOperationalInternal":{"tmp":"tmp/cli_1.1.0-rc.0_1747763332494_0.9281293875731451","host":"s3://npm-registry-packages-npm-production"}},"1.1.0":{"name":"@pdfmonkey/cli","version":"1.1.0","keywords":["PDFMonkey","PDF","CLI","automation","tools"],"author":{"name":"Simon Courtois"},"license":"MIT","_id":"@pdfmonkey/cli@1.1.0","maintainers":[{"name":"tiny-monkey","email":"accounts@pdfmonkey.io"}],"homepage":"https://pdfmonkey.io","bugs":{"url":"https://github.com/pdfmonkey/pdfmonkey-cli/issues"},"bin":{"pdfmonkey":"bin/index.js"},"dist":{"shasum":"778aa5d034a2b42ca4d9b46d5b9913d7ddf76731","tarball":"https://registry.npmjs.org/@pdfmonkey/cli/-/cli-1.1.0.tgz","fileCount":22,"integrity":"sha512-LcyRZtbZR0TkCFrcUiMqGfKd1fXYOWH6fkC7TvJm9vEkO9AWc7u1x1MkOY5gOXkLkCgc88L1ysXR7/hW0gaTag==","signatures":[{"sig":"MEUCIBFJjvQRtDHxYGIEd+nnP975WdWWj6nfqQ+jJUN2N6C+AiEAqOkGDONy8RzFQzTorvR/IJTYkm9nHXD2T6KrZt4Stmo=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@pdfmonkey%2fcli@1.1.0","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":57412},"main":"index.js","node":">=18","type":"module","gitHead":"6d49810be90de82d6a278b6a135e2514d2c610c0","scripts":{"lint":"eslint .","format":"prettier --write .","prepare":"husky","lint:fix":"eslint . --fix","format:check":"prettier --check ."},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:03b379d8-0129-48a3-8d10-e7d8d1dde610"}},"repository":{"url":"git+https://github.com/pdfmonkey/pdfmonkey-cli.git","type":"git"},"_npmVersion":"11.8.0","description":"A CLI tool to edit your PDFMonkey template locally with your favorite tools.","directories":{},"lint-staged":{"*.{js,jsx,ts,tsx}":["eslint --fix","prettier --write"]},"_nodeVersion":"22.22.0","dependencies":{"diff":"^7.0.0","open":"^10.1.0","chalk":"^5.4.1","chokidar":"^4.0.3","commander":"^13.0.0","livereload":"^0.9.3","shell-escape":"^0.2.0","@clack/prompts":"^0.9.1"},"publishConfig":{"access":"public","provenance":true},"_hasShrinkwrap":false,"devDependencies":{"husky":"^9.1.7","eslint":"^9.18.0","globals":"^15.14.0","prettier":"^3.4.2","@eslint/js":"^9.18.0","lint-staged":"^15.4.1","eslint-config-prettier":"^10.0.1","eslint-plugin-prettier":"^5.2.2"},"_npmOperationalInternal":{"tmp":"tmp/cli_1.1.0_1770122306750_0.512143674270183","host":"s3://npm-registry-packages-npm-production"}},"2.0.0":{"name":"@pdfmonkey/cli","version":"2.0.0","keywords":["PDFMonkey","PDF","CLI","automation","tools"],"author":{"name":"Simon Courtois"},"license":"MIT","_id":"@pdfmonkey/cli@2.0.0","maintainers":[{"name":"tiny-monkey","email":"accounts@pdfmonkey.io"}],"homepage":"https://pdfmonkey.io","bugs":{"url":"https://github.com/pdfmonkey/pdfmonkey-cli/issues"},"bin":{"pdfmonkey":"bin/index.js"},"dist":{"shasum":"28ad4b8d751a644044061c00d68f17cb828c38d6","tarball":"https://registry.npmjs.org/@pdfmonkey/cli/-/cli-2.0.0.tgz","fileCount":27,"integrity":"sha512-0UlIJq2gi4/rNyZ9quCGi501KRPq3DKcXpQr/gBH6mQ+fkN1W/rIb10OKpMot0501QkI6JaprxVTxVjPfvR/gQ==","signatures":[{"sig":"MEYCIQDtIZqh/wFhHgVhaUSKcHkrRlcbOqzOGuEfQ3zx/5JAmQIhAMn0Z84YgcV2ve0eyntoEsR3cfGm5siGCYhcOV4KbQa/","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"},{"sig":"MEUCIQC2Z5Rkz5pTITTAENXiLE+815DmO3vNBUfkBnuHGk3EEAIgVd5bS+2vi4/+UKyos/f06kjynBrVqfbjFZ2rjqH2pUY=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@pdfmonkey%2fcli@2.0.0","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":86478},"type":"module","engines":{"node":">=22.12"},"gitHead":"1f06a8884571a6fb8c30c87a2c22e6cf245c2d3d","scripts":{"lint":"eslint .","format":"prettier --write .","prepare":"husky","lint:fix":"eslint . --fix","format:check":"prettier --check ."},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"03b379d8-0129-48a3-8d10-e7d8d1dde610"}},"repository":{"url":"git+https://github.com/pdfmonkey/pdfmonkey-cli.git","type":"git"},"_npmVersion":"12.2.0","description":"A CLI tool to manage your PDFMonkey templates, snippets and documents, and edit templates locally with your favorite tools.","directories":{},"lint-staged":{"*.{js,jsx,ts,tsx}":["eslint --fix","prettier --write"]},"_nodeVersion":"22.23.3","dependencies":{"open":"^11.0.4","chalk":"^6.0.1","chokidar":"^5.0.0","commander":"^15.0.0","pdfmonkey":"^1.4.0","livereload":"^0.10.3","@clack/prompts":"^1.8.1"},"publishConfig":{"access":"public","provenance":true},"_hasShrinkwrap":false,"devDependencies":{"husky":"^9.1.7","eslint":"^10.11.0","globals":"^17.13.0","prettier":"^3.9.9","@eslint/js":"^10.0.1","lint-staged":"^17.6.0","eslint-config-prettier":"^10.1.8","eslint-plugin-prettier":"^5.5.6"},"_npmOperationalInternal":{"tmp":"tmp/cli_2.0.0_1791879193922_0.023478238768678272","host":"s3://npm-registry-packages-npm-production"}},"2.1.0":{"_id":"@pdfmonkey/cli@2.1.0","bin":{"pdfmonkey":"bin/index.js"},"bugs":{"url":"https://github.com/pdfmonkey/pdfmonkey-cli/issues"},"dist":{"shasum":"6884cf2e9052a6c35b9deba34f46c9751ad133e7","tarball":"https://registry.npmjs.org/@pdfmonkey/cli/-/cli-2.1.0.tgz","fileCount":27,"integrity":"sha512-zN04aLVGU3pM470SNV5hPb/njXvdhr7JJd4Z2wcA5fRtgk70+UnDGzaxLtv21vd1xJwn6xanpZOBirIu47HiAg==","signatures":[{"sig":"MEUCIGGN/xYnmn8zfQ1G8Gs5brqMmbfOM7bzrPR34WyNeD/oAiEAuv9LlwbeCpPTjT/cuF8HUpjPH7pVYf99YP9SyTfKVYY=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"},{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIC9+juPw1W3DRboAbf6rr0ClTuxlhHgEe5gQtuISKKAmAiEA9kdcnu9N1D47vKv4rK8bxDMygYUb6aeNKoj7ahgVSLo="}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@pdfmonkey%2fcli@2.1.0","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":88390},"name":"@pdfmonkey/cli","type":"module","author":{"name":"Simon Courtois"},"engines":{"node":">=22.12"},"gitHead":"2c1980de5112f1da4c558ea600d79716043844a1","license":"MIT","scripts":{"lint":"eslint .","format":"prettier --write .","prepare":"husky","lint:fix":"eslint . --fix","format:check":"prettier --check ."},"version":"2.1.0","_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"03b379d8-0129-48a3-8d10-e7d8d1dde610"}},"homepage":"https://pdfmonkey.io","keywords":["PDFMonkey","PDF","CLI","automation","tools"],"repository":{"url":"git+https://github.com/pdfmonkey/pdfmonkey-cli.git","type":"git"},"_npmVersion":"12.2.0","description":"A CLI tool to manage your PDFMonkey templates, snippets and documents, and edit templates locally with your favorite tools.","directories":{},"lint-staged":{"*.{js,jsx,ts,tsx}":["eslint --fix","prettier --write"]},"maintainers":[{"name":"tiny-monkey","email":"accounts@pdfmonkey.io"}],"_nodeVersion":"22.23.3","dependencies":{"open":"^11.0.4","chalk":"^6.0.1","chokidar":"^5.0.0","commander":"^15.0.0","pdfmonkey":"^1.4.0","livereload":"^0.10.3","@clack/prompts":"^1.8.1"},"publishConfig":{"access":"public","provenance":true},"_hasShrinkwrap":false,"devDependencies":{"husky":"^9.1.7","eslint":"^10.11.0","globals":"^17.13.0","prettier":"^3.9.9","@eslint/js":"^10.0.1","lint-staged":"^17.6.0","eslint-config-prettier":"^10.1.8","eslint-plugin-prettier":"^5.5.6"},"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/cli_2.1.0_1792062018617_0.9178204744085912"}}},"time":{"created":"2025-01-24T12:33:40.724Z","modified":"2026-10-15T11:00:19.083Z","1.0.0":"2025-01-24T12:33:41.086Z","1.0.1":"2025-01-24T12:48:16.996Z","1.0.2":"2025-01-24T13:08:00.408Z","1.1.0-rc.0":"2025-05-20T17:48:52.691Z","1.1.0":"2026-02-03T12:38:26.896Z","2.0.0":"2026-10-13T08:13:14.014Z","2.1.0":"2026-10-15T11:00:18.700Z"},"bugs":{"url":"https://github.com/pdfmonkey/pdfmonkey-cli/issues"},"author":{"name":"Simon Courtois"},"license":"MIT","homepage":"https://pdfmonkey.io","keywords":["PDFMonkey","PDF","CLI","automation","tools"],"repository":{"url":"git+https://github.com/pdfmonkey/pdfmonkey-cli.git","type":"git"},"description":"A CLI tool to manage your PDFMonkey templates, snippets and documents, and edit templates locally with your favorite tools.","maintainers":[{"name":"tiny-monkey","email":"accounts@pdfmonkey.io"}],"readme":"![PDFMonkey CLI](/assets/logo-cli.svg)\n\n# PDFMonkey CLI\n\nThis CLI tool is a great solution for developers who want to author [PDFMonkey](https://pdfmonkey.io) templates using their own code editor and local development environment.\n\nIt also lets you manage your workspaces, templates, folders, snippets and documents from the terminal, from scripts or from an AI agent.\n\n## Installation\n\nThe PDFMonkey CLI requires Node.js 22.12 or later and can be installed using npm.\n\n```bash\nnpm install -g @pdfmonkey/cli\n```\n\nOnce installed, the `pdfmonkey` command will be available in your terminal.\n\n## Help\n\nTo get a list of available commands and general help, run the following command:\n\n```bash\npdfmonkey help\n```\n\n## Authentication\n\nThere are two ways to authenticate with the PDFMonkey CLI:\n\n1. All commands accept the `-k` or `--api-key` option to specify an API key.\n2. You can also set the `PDFMONKEY_API_KEY` environment variable.\n\n> [!IMPORTANT]\n> **API Key in this README**\n>\n> The commands below will **assume the API key is set in the environment variable.**\n\n## Command Structure\n\nCommands are organized by resource type:\n\n```bash\npdfmonkey <resource> <command> [options]\n```\n\nCurrently supported resources:\n\n- `workspace` or `ws`: List PDFMonkey workspaces\n- `template` or `tpl`: Manage PDFMonkey templates\n- `folder` or `fld`: Manage PDFMonkey template folders\n- `snippet` or `snp`: Manage PDFMonkey snippets\n- `document` or `doc`: Manage PDFMonkey documents\n\nFor example:\n\n```bash\npdfmonkey template init <template-id>\n# or using the shorthand alias\npdfmonkey tpl init <template-id>\n```\n\nCommon commands also have short aliases: `list` → `ls`, `get` → `show`, `delete` → `rm` and, for documents, `create` → `generate`.\n\nA few commands live at the top level:\n\n- `pdfmonkey init`: initialize several templates and snippets in a row (see [Init Multiple Resources](#init-multiple-resources))\n- `pdfmonkey watch`: watch a template and its snippets together (see [Watch Multiple Resources](#watch-multiple-resources))\n- `pdfmonkey whoami`: show the account the API key belongs to\n\n## Template Management\n\n### Init\n\nTo start editing a PDFMonkey template, run the following command:\n\n```bash\npdfmonkey template init\n```\n\nThe command will help you select a workspace and find the template you want to edit.\n\nAlternatively, you can specify the template ID as a second argument.\n\n```bash\npdfmonkey template init <template-id>\n```\n\nYou will then be prompted to choose the destination directory for the template files. You can also specify the destination directory as a second argument.\n\n```bash\npdfmonkey template init <template-id> <destination-directory>\n```\n\n> [!TIP]\n> **Open in Editor**\n>\n> You can also open the created directory in your default editor using the `-e` or `--edit` option.\n>\n> ```bash\n> pdfmonkey template init <template-id> -e\n> ```\n\n### Watch\n\nTo start watching a template directory and sync the changes to PDFMonkey, run the following command:\n\n```bash\npdfmonkey template watch\n```\n\nThis will start watching files in **the current directory** and sync automatically. The CLI uses the metadata stored in the `.pdfmonkey.json` file to identify the template.\n\nTo monitor a different directory, simply pass the path as the first argument:\n\n```bash\npdfmonkey template watch <path>\n```\n\nIf for some reason the directory doesn't contain metadata or you want to use a different template ID, you can specify it using the `-t` option:\n\n```bash\npdfmonkey template watch [path] -t <template-id>\n```\n\n### Preview\n\nThe `watch` command will start a local server to preview the template. The preview will automatically refresh when changes are synced.\n\nYou can open the preview when the server is running using the `-o` or `--open-browser` option.\n\n```bash\npdfmonkey template watch -o\n```\n\nBy default, the preview server runs on port 2081 and the live-reload server runs on port 2082. You can specify different ports using the `-p/--port` and `-l/--livereload-port` options.\n\n```bash\npdfmonkey template watch -p 2083 -l 2084\n```\n\nAlternatively, you can set the `PORT` and `LIVE_RELOAD_PORT` environment variables to customize the ports.\n\n```bash\nPORT=2083 LIVE_RELOAD_PORT=2084 pdfmonkey template watch\n```\n\n### Debug Preview\n\nSometimes, it can be easier to debug the generated HTML instead of the PDF. You can do this by using the `-D` or `--debug` option.\n\n```bash\npdfmonkey template watch -D -o\n```\n\nThis will open the debug preview in your default browser.\n\n### Dealing with conflicts\n\nWhen starting the `watch` command, the CLI will check if there are any conflicts between the local files and the template data. If there are, you will be prompted to choose between:\n\n1. Overwrite the local files with the template data.\n2. Keep the local files and override the template data on the next sync.\n3. To see a diff of the changes.\n\nBy default, the diff tool used is `diff -u` and the patch is displayed with the `less` pager. You can specify different diff-tool and pager using the `DIFF` and `PAGER` environment variables, respectively.\n\n```bash\nDIFF=delta PAGER=delta pdfmonkey template watch\n```\n\n## Snippet Management\n\n### Init\n\nTo start editing a PDFMonkey snippet, run the following command:\n\n```bash\npdfmonkey snippet init\n```\n\nThe command will help you select a workspace and find the snippet you want to edit.\n\nAlternatively, you can specify the snippet ID as a second argument.\n\n```bash\npdfmonkey snippet init <snippet-id>\n```\n\nYou will then be prompted to choose the destination directory for the snippet. You can also specify the destination directory as a second argument.\n\n```bash\npdfmonkey snippet init <snippet-id> <destination-directory>\n```\n\nThe snippet will be stored in a directory structure similar to templates, with the code in a file named `code.liquid`.\n\n> [!TIP]\n> **Open in Editor**\n>\n> You can also open the created file in your default editor using the `-e` or `--edit` option.\n>\n> ```bash\n> pdfmonkey snippet init <snippet-id> -e\n> ```\n\n### Watch\n\nTo start watching a snippet directory and sync the changes to PDFMonkey, run the following command:\n\n```bash\npdfmonkey snippet watch\n```\n\nThis will start watching the `code.liquid` file in the **current directory** and sync automatically when changes are detected. The CLI uses the metadata stored in the `.pdfmonkey.json` file to identify the snippet.\n\nTo monitor a different directory, simply pass the path as the first argument:\n\n```bash\npdfmonkey snippet watch <path>\n```\n\nIf for some reason the directory doesn't contain metadata or you want to use a different snippet ID, you can specify it using the `-s` option:\n\n```bash\npdfmonkey snippet watch [path] -s <snippet-id>\n```\n\n## Init Multiple Resources\n\nTo initialize several templates and snippets one after the other, run:\n\n```bash\npdfmonkey init\n```\n\nFor each resource, you will be asked whether it's a template or a snippet, then guided through the same steps as `template init` and `snippet init`. The `-e, --edit` option opens each initialized resource in your editor.\n\n## Watch Multiple Resources\n\nThe CLI allows you to watch multiple resources (one template and multiple snippets) simultaneously with a single command:\n\n```bash\npdfmonkey watch\n```\n\nIf the current directory is a template or snippet directory, it is watched directly. Otherwise, you will be prompted to select the directories to watch among the ones found up to two levels below the current directory.\n\nYou can also directly specify multiple paths:\n\n```bash\npdfmonkey watch path/to/template path/to/snippet\n```\n\nWhen watching multiple resources, the command will automatically detect if each directory contains a template or a snippet based on the metadata. Note that **only one template can be watched at a time**, but you can watch multiple snippets alongside it.\n\nThis combined watch command supports the same options as the `template watch` command:\n\n```bash\npdfmonkey watch -o -p 2083 -l 2084\n```\n\n## Managing resources\n\nBesides local edition, the CLI covers the everyday operations on your PDFMonkey resources. Every command has a `--help` option listing all its options.\n\n### Workspaces\n\nCommands that work within a workspace accept a `-w, --workspace` option taking either the workspace ID or its name. You can also set the `PDFMONKEY_WORKSPACE` environment variable. When none is given in an interactive terminal, the CLI will ask you to pick one.\n\n```bash\npdfmonkey whoami          # Check which account the API key belongs to\npdfmonkey workspace list\n```\n\n### Templates\n\n```bash\npdfmonkey template list                       # Across all workspaces\npdfmonkey template list -w \"My Workspace\"     # In a workspace\npdfmonkey template list -w \"My Workspace\" -f Invoices   # In a folder (ID or name), or \"none\"\npdfmonkey template get <template-id>          # Use --json to get the full content\n\npdfmonkey template create -w \"My Workspace\" -n \"Invoice\" --from ./invoice\npdfmonkey template create -w \"My Workspace\" -n \"Invoice\" --mode builder --folder Invoices\npdfmonkey template create -w \"My Workspace\" -n \"Badge\" --output-type image --engine v5\npdfmonkey template update <template-id> --from ./invoice\npdfmonkey template update <template-id> -n \"New name\" --folder none\npdfmonkey template publish <template-id>\npdfmonkey template delete <template-id>\n```\n\n`--from` reads the content from a local template directory (`body.html.liquid`, `styles.scss` and `sample_data.json`), the same layout used by `init` and `watch`. When creating a template, the directory is linked to the new template so you can `watch` it right away.\n\nLike in the dashboard, changes are saved as a draft: use `publish` to make them live.\n\n### Folders\n\n```bash\npdfmonkey folder list -w \"My Workspace\"\npdfmonkey folder create -w \"My Workspace\" -n \"Invoices\"\npdfmonkey folder rename <folder-id> \"Quotes\"\npdfmonkey folder delete <folder-id>\n```\n\n### Snippets\n\n```bash\npdfmonkey snippet list -w \"My Workspace\" [--search header]\npdfmonkey snippet get <snippet-id>\npdfmonkey snippet create -w \"My Workspace\" -n \"header\" --from ./header\npdfmonkey snippet update <snippet-id> --from ./header\npdfmonkey snippet delete <snippet-id>\n```\n\n`--from` reads the code from the `code.liquid` file of a local snippet directory.\n\n### Documents\n\n```bash\npdfmonkey document list -w \"My Workspace\"\npdfmonkey document list -t <template-id>,<template-id> -s failure --updated-since 2026-01-01\npdfmonkey document list -q invoice-42 --page 2\npdfmonkey document get <document-id>          # Use --json to get the payload and generation logs\n\npdfmonkey document create -t <template-id> --payload @data.json -o ./invoices/\npdfmonkey document create -t <template-id> --payload '{\"name\": \"Alice\"}' --meta '{\"_filename\": \"alice.pdf\"}' --wait\ncat data.json | pdfmonkey document create -t <template-id> --payload - --draft\npdfmonkey document update <document-id> --payload @data.json --generate --wait\npdfmonkey document download <document-id> [path]\npdfmonkey document delete <document-id>\n```\n\n`--payload` and `--meta` accept inline JSON, a file (`@path/to/file.json`) or the standard input (`-`). Documents are generated right away unless `--draft` is given. `-o, --output` downloads the generated file to a path or directory once ready.\n\nThe available filters for `document list` are the template(s), the status (`draft`, `pending`, `generating`, `success` or `failure`), a search on the filename or ID, and the last update date.\n\n## Scripting and AI agents\n\nThe CLI is designed to be used by scripts and LLM-based agents as well as humans:\n\n- Every command accepts `--json` to output raw JSON, e.g. `pdfmonkey template list --json | jq '.[].id'`.\n- Commands never prompt when all required options are given. Without a terminal, missing information is an error rather than a prompt.\n- Deletions require `-y, --yes` when not run in an interactive terminal.\n- Errors are printed on the standard error output and the process exits with a non-zero code.\n\n## Metadata\n\nThe CLI stores metadata in a `.pdfmonkey.json` file within each resource directory. This file contains the resource type and ID, allowing commands to run without explicitly specifying IDs. This metadata is automatically created when initializing resources and used by the watch commands.\n\nThe `.pdfmonkey.json` file looks like this:\n\n```json\n{\n  \"type\": \"template\",\n  \"id\": \"123e4567-e89b-12d3-a456-426614174000\"\n}\n```\n\n## Configuration\n\nHere is a summary of the environment variables that can be set to customize the behavior of the CLI:\n\n- `PDFMONKEY_API_KEY`: The API key to use for authentication.\n- `PDFMONKEY_WORKSPACE`: The default workspace (ID or name).\n- `PDFMONKEY_API_BASE`: The base URL of the API (default: `https://api.pdfmonkey.io/api/v1`).\n- `EDITOR`: The editor opened by the `-e, --edit` option of `init` commands.\n- `DIFF`: The diff tool to use.\n- `PAGER`: The pager to use when displaying diffs.\n- `PORT`: The port to run the preview server on.\n- `LIVE_RELOAD_PORT`: The port to run the live-reload server on.\n\n## License\n\nThis project is open-sourced under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Contributing\n\nContributions are welcome! Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for details.\n","readmeFilename":"README.md"}