{"id":30818323,"url":"https://github.com/ahmed-musallam/aem-backup-cli","last_synced_at":"2025-09-06T09:49:27.045Z","repository":{"id":57173883,"uuid":"141956427","full_name":"ahmed-musallam/aem-backup-cli","owner":"ahmed-musallam","description":"A Developer CLI utility to backup local AEM instances, and save lives!","archived":false,"fork":false,"pushed_at":"2018-07-24T18:41:06.000Z","size":58,"stargazers_count":18,"open_issues_count":1,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-09-24T09:12:04.739Z","etag":null,"topics":["aem","cli","cq"],"latest_commit_sha":null,"homepage":"https://blogs.perficientdigital.com/2019/01/24/aem-backup-cli-rapid-backup-restore-of-your-aem-instances/","language":"JavaScript","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/ahmed-musallam.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}},"created_at":"2018-07-23T03:28:14.000Z","updated_at":"2024-01-11T23:58:25.000Z","dependencies_parsed_at":"2022-09-02T09:23:37.333Z","dependency_job_id":null,"html_url":"https://github.com/ahmed-musallam/aem-backup-cli","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/ahmed-musallam/aem-backup-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahmed-musallam%2Faem-backup-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahmed-musallam%2Faem-backup-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahmed-musallam%2Faem-backup-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahmed-musallam%2Faem-backup-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ahmed-musallam","download_url":"https://codeload.github.com/ahmed-musallam/aem-backup-cli/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahmed-musallam%2Faem-backup-cli/sbom","scorecard":{"id":172092,"data":{"date":"2025-08-11","repo":{"name":"github.com/ahmed-musallam/aem-backup-cli","commit":"60922d3d65f3fca8bb86a8d8586cde22696f5cd0"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.6,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/18 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":0,"reason":"license file not detected","details":["Warn: project does not have a license file"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}}]},"last_synced_at":"2025-08-16T16:50:17.266Z","repository_id":57173883,"created_at":"2025-08-16T16:50:17.266Z","updated_at":"2025-08-16T16:50:17.266Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273886638,"owners_count":25185509,"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","status":"online","status_checked_at":"2025-09-06T02:00:13.247Z","response_time":2576,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["aem","cli","cq"],"created_at":"2025-09-06T09:49:23.899Z","updated_at":"2025-09-06T09:49:26.999Z","avatar_url":"https://github.com/ahmed-musallam.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)\n# aem-backup-cli\nA Developer CLI utility to backup local AEM instances, and save lives!\n\n\u003e If you like this utility, please consider starring 🤩 to let me know you like it!\n\n\u003e windows users: let me know if it works on windows 😅\n\n\n\u003cp align=\"center\"\u003e\n  \u003cbr\u003e\n  \u003cimg src=\"screenshot.svg\"\u003e\n  \u003cbr\u003e\n\u003c/p\u003e\n\n## About\nIf you're an AEM dev, you understand the **frustration** of a broken AEM instance during development. This CLI will backup your instance so you can restore it at any time!\n\n## How it works\nConsider this AEM instance directory structure:\n\n```\n|-- aem-instance-directory       # The AEM instance directory\n    |-- quickstart.jar\n    |-- crx-quickstart\n    |-- license.properties\n    |-- crx-quickstart.backup    # folder added by aem-backup-cli\n        |-- some-backup.tar      # sample user-generated backup  \n        |-- another-backup.tar   # another sample user-generated backup \n```\n\u003e Moving forward, I will be referring to `aem-instance-directory` above as the \"AEM instance Directory\"\n\nUsing the [`node-tar`](https://github.com/npm/node-tar) module, this CLI creates a [tar](https://en.wikipedia.org/wiki/Tar_(computing)) archive (tarball) of the `crx-quickstart` folder and saves the resulting tar into a sibling folder called `crx-quickstart.backups`.\n\nPlease note:\n\n- Since this is a **filesystem** backup, the AEM instance **must** be completely shutdown.\n- This CLI does not perform compression, as it's aimed for speed not saving disk space.\n\n## Install and Usage\n\n```console\n# install the cli (adds 'aemb' to the command line)\n\n$ npm install -g aem-backup-cli\n```\n```console\n# before running `aemb`, make sure you `cd` into  your\n# AEM instance directory (`aem-instance-directory` from above)\n\n$ aemb\n```\nInteractive cli is now open! typing `help` generates:\n\n```console\naemb$ help\n\n  Commands:\n\n    help [command...]              Provides help for a given command.\n    exit                           Exits application.\n    backup [options] [backupName]  Archive crx-quickstart in current directory and move archive to crx-quickstart.backups folder in current directory\n    list                           List all available backups\n    delete [options]               Delete a backup from available backups\n    restore [options]              Restore a backup from a list of available backups\n```\n\n### Examples\n\n```console\n# create backup named my-first-backup\naemb$ backup my-first-backup\n```\n\n```console\n# List available backups\naemb$ list\n```\n```console\n# restore a backup from a list of backups\naemb$ restore\n```\n```console\n# delete a backup from a list of backups\naemb$ delete\n```\n\n## Interacting with `crx-quickstart.backups` folder\nYou can **manually** add/remove/rename backup tars to your hearts content. you can also safely remove the whole folder if you no longer need it.\n\n \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fahmed-musallam%2Faem-backup-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fahmed-musallam%2Faem-backup-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fahmed-musallam%2Faem-backup-cli/lists"}