{"id":27938528,"url":"https://github.com/willowtreeapps/dotcms-utils","last_synced_at":"2025-05-07T08:49:01.799Z","repository":{"id":40716121,"uuid":"266190814","full_name":"willowtreeapps/dotcms-utils","owner":"willowtreeapps","description":"CLI and utilities library for interacting with dotCMS","archived":false,"fork":false,"pushed_at":"2023-07-12T06:55:31.000Z","size":54,"stargazers_count":0,"open_issues_count":8,"forks_count":0,"subscribers_count":111,"default_branch":"master","last_synced_at":"2025-04-28T06:37:16.536Z","etag":null,"topics":["dotcms"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/willowtreeapps.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-05-22T19:23:59.000Z","updated_at":"2020-06-10T13:51:54.000Z","dependencies_parsed_at":"2024-10-03T17:22:52.460Z","dependency_job_id":"c77c46db-7196-4fa5-b059-a500a79a3965","html_url":"https://github.com/willowtreeapps/dotcms-utils","commit_stats":{"total_commits":3,"total_committers":1,"mean_commits":3.0,"dds":0.0,"last_synced_commit":"a84cb251f484fe24119c20aacb7fe27fe82790c4"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willowtreeapps%2Fdotcms-utils","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willowtreeapps%2Fdotcms-utils/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willowtreeapps%2Fdotcms-utils/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willowtreeapps%2Fdotcms-utils/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/willowtreeapps","download_url":"https://codeload.github.com/willowtreeapps/dotcms-utils/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252847213,"owners_count":21813436,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dotcms"],"created_at":"2025-05-07T08:49:00.792Z","updated_at":"2025-05-07T08:49:01.784Z","avatar_url":"https://github.com/willowtreeapps.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# dotcms-utils\n\nCLI and utilities library for interacting with dotCMS.\n\n## Usage\n\n```bash\n# Install globally\nnpm i -g @willowtreeapps/dotcms-utils\n\n# See all available options\ndotcms-utils\n\n# Step through initialization of dotcms.config.json\ndotcms-utils init\n```\n\n### `dotcms.config.json`\n\nContains dotCMS-related configuration used by dotcms-utils.\n\n**This file should NOT be checked in to source control.** Plaintext credentials may be stored in this file so it's best to avoid keeping it in revision history. Instead, consider sharing it only with project contributors who require it.\n\n### Commands\n\n#### init\n\nInitialize a new dotCMS target to be used by other `dotcms-utils` commands.\n\n```bash\ndotcms-utils init\n```\n\nAfter following instructions, `dotcms.config.json` will either be created or updated in your project's root directory.\n\n#### config\n\nPrint contents of `dotcms.config.json`.\n\n```bash\ndotcms-utils config\n```\n\n#### token\n\nGenerate an API access token for a dotCMS target.\n\n```bash\ndotcms-utils token \u003ctarget\u003e\n\n# Print existing token in prod target configuration\ndotcms-utils token prod\n\n# Create new token and save it in configuration\ndotcms-utils token prod --create --save --label \"CI token\" --expiration 365\n```\n\n#### bundle-diff\n\nGenerate the diff of a bundle between two dotCMS targets. By default, outputs to `diff.html` in the current working directory.\n\n```bash\ndotcms-utils bundle-diff \u003csrc\u003e \u003cdest\u003e \u003cbundleId\u003e\n\n# Diff a release bundle from non-prod against prod.\ndotcms-utils bundle-diff nonprod prod 2DOT8\n```\n\n## Contributing\n\nPlease read through open issues to find ideas for contributing. Code additions are welcome through pull requests.\n\n### Guidelines\n\n- Use the REST API with API access keys wherever possible.\n- Prefer using the [dotcms npm module](https://www.npmjs.com/package/dotcms) instead of directly using `fetch`.\n- Use [Angular commit message syntax.](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-guidelines)\n  ```\n  \u003ctype\u003e(\u003cscope\u003e): \u003csubject\u003e\n  \u003cBLANK LINE\u003e\n  \u003cbody\u003e\n  \u003cBLANK LINE\u003e\n  \u003cfooter\u003e\n  ```\n  ```\n  feat(deploy): recursively create non-existent directories\n  ```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwillowtreeapps%2Fdotcms-utils","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwillowtreeapps%2Fdotcms-utils","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwillowtreeapps%2Fdotcms-utils/lists"}