{"id":13805547,"url":"https://github.com/ember-cli/ember-cli-update","last_synced_at":"2025-06-24T11:07:23.402Z","repository":{"id":23101834,"uuid":"98127948","full_name":"ember-cli/ember-cli-update","owner":"ember-cli","description":"Update Ember CLI projects","archived":false,"fork":false,"pushed_at":"2024-07-22T01:48:48.000Z","size":7226,"stargazers_count":278,"open_issues_count":76,"forks_count":41,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-06-14T05:22:39.151Z","etag":null,"topics":["hacktoberfest"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ember-cli.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","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":"2017-07-23T21:59:36.000Z","updated_at":"2025-06-05T07:05:16.000Z","dependencies_parsed_at":"2023-01-13T22:45:35.484Z","dependency_job_id":"ccda1696-fc17-4d78-82c3-bd211125d5cb","html_url":"https://github.com/ember-cli/ember-cli-update","commit_stats":{"total_commits":1337,"total_committers":26,"mean_commits":51.42307692307692,"dds":"0.26028421839940163","last_synced_commit":"1042e156cf35b5990bfb3d4bd7b1ba8f9be87d1f"},"previous_names":[],"tags_count":225,"template":false,"template_full_name":null,"purl":"pkg:github/ember-cli/ember-cli-update","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ember-cli%2Fember-cli-update","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ember-cli%2Fember-cli-update/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ember-cli%2Fember-cli-update/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ember-cli%2Fember-cli-update/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ember-cli","download_url":"https://codeload.github.com/ember-cli/ember-cli-update/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ember-cli%2Fember-cli-update/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260577574,"owners_count":23030763,"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":["hacktoberfest"],"created_at":"2024-08-04T01:01:02.208Z","updated_at":"2025-06-24T11:07:23.381Z","avatar_url":"https://github.com/ember-cli.png","language":"JavaScript","readme":"# ember-cli-update\n\n[![npm version](https://badge.fury.io/js/ember-cli-update.svg)](https://badge.fury.io/js/ember-cli-update)\n![](https://github.com/ember-cli/ember-cli-update/workflows/CI/badge.svg)\n[![Build status](https://ci.appveyor.com/api/projects/status/iguxxyxkiu9kyeyo/branch/master?svg=true)](https://ci.appveyor.com/project/embercli/ember-cli-update/branch/master)\n\n![logo](./public/ecu-final.svg)\n\nUpdate [Ember CLI](https://ember-cli.com/) projects\n\nThe 2 use cases are:\n1. Updating a project's boilerplate code from an older Ember version to a newer one like 3.4.0 to 3.20.0 for example. These are called base blueprints and there are 3 types officially provided by ember-cli: `app`, `addon`, and `glimmer`.\n   - This is different from the existing `ember init` command. That command tries to reset your project back to a brand new project. It removes all your changes and additions.\n2. Updating boilerplate code for a blueprint from an Ember addon from an older version to a newer one. These are called custom blueprints.\n\nCheck out [the wiki guide](https://github.com/ember-cli/ember-cli-update/wiki) for more details.\n\nYou can run the CLI either as a global executable available to all projects or an Ember CLI command in a single project.\n\nThe CLI attempts to be a thin wrapper of [boilerplate-update](https://github.com/kellyselden/boilerplate-update).\n\n## Installation\n\nAs a global executable:\n\n`npm install -g ember-cli-update`\n\nAs an Ember CLI command:\n\n`ember install ember-cli-update`\n\n(You must commit the change to `package.json` before running the update command or else you get an error.)\n\n## Usage\n\nMake sure your git working directory is clean before updating.\n\nInside your project directory, if you installed globally run\n\n`ember-cli-update`\n\nor if you installed as an Ember CLI command run\n\n`ember update`\n\nThis will update your app or addon to the latest Ember CLI version. It does this by fetching the latest version and comparing it to your project's Ember CLI version. It then applies a diff of the changes from the latest version to your project. It will only modify the files if there are changes between your project's version and the latest version, and it will only change the section necessary, not the entire file.\n\nThis is different from the existing `ember init` command. That command tries to reset your project back to a brand new project. It removes all your changes and additions.\n\nYou will probably encounter merge conflicts, in which the default behavior is to let you resolve conflicts on your own. You can supply the `--resolve-conflicts` option to run your system's git merge tool if any conflicts are found.\n\nThis tool can also run codemods for you. The option `--run-codemods` will figure out what codemods apply to your current version of Ember.js, and download and run them for you.\n\n## Examples\n\n(These examples assume you are using the global command.)\n\nTo update to the latest version of Ember CLI:\n\n```\nember-cli-update\n```\n\nTo update to a certain version of Ember CLI:\n\n```\nember-cli-update --to 3.1.0\n```\n\nTo run codemods:\n\n(This should be run after running the normal update shown above, and after you've resolved any conflicts.)\n\n```\nember-cli-update --run-codemods\n```\n\n## Commands\n\n\u003c!-- CODEGEN_CLI_HELP --\u003e\n\n```\nember-cli-update\n\nCommands:\n  ember-cli-update bootstrap        saves the detected blueprint state\n  ember-cli-update codemods         Run codemods to help update your code\n  ember-cli-update compare          Show the changes between different versions\n                                    without updating\n  ember-cli-update init             initialize a blueprint\n  ember-cli-update install \u003caddon\u003e  install an addon\n  ember-cli-update reset            reset a blueprint\n  ember-cli-update save             save old blueprint state\n  ember-cli-update stats            list blueprint version updates\n\nOptions:\n      --help                     Show help                             [boolean]\n      --version                  Show version number                   [boolean]\n  -p, --package-name, --package  Provide a package that can contain many\n                                 blueprints (\"@glimmer/blueprint\", \"git+https://\n                                 git@github.com/tildeio/libkit.git\",\n                                 \"../blueprint\")                        [string]\n  -b, --blueprint                Provide a custom blueprint for use in the\n                                 update (\"@glimmer/blueprint\", \"git+https://git@\n                                 github.com/tildeio/libkit.git\", \"../blueprint\")\n                                                                        [string]\n      --from                     Use a starting version that is different than\n                                 what is in your package.json (\"2.9.1\") [string]\n      --to                       Update to a version that isn't latest\n                                 (\"2.14.1\", \"~2.15\", \"latest\", \"beta\")  [string]\n      --resolve-conflicts        Automatically run git mergetool if conflicts\n                                 found                [boolean] [default: false]\n      --run-codemods             Run codemods to help update your code\n                                                      [boolean] [default: false]\n      --codemods-source          Supply your own codemods manifest via URL\n                                 (\"ember-app-codemods-manifest@*\",\n                                 \"git+https://github.com/ember-cli/ember-app-cod\n                                 emods-manifest.git#semver:*\")          [string]\n      --codemods-json            Supply your own codemods manifest via JSON (`{\n                                 /* json */ }`)                         [string]\n      --reset                    Reset your code to the default blueprint at the\n                                 new version          [boolean] [default: false]\n      --compare-only             Show the changes between different versions\n                                 without updating     [boolean] [default: false]\n      --stats-only               Show all calculated values regarding your\n                                 project              [boolean] [default: false]\n      --list-codemods            List available codemods\n                                                      [boolean] [default: false]\n      --output-repo              An output repository of changes over time\n                                                                        [string]\n\nember-cli-update bootstrap\n\nsaves the detected blueprint state\n\nOptions:\n  --help     Show help                                                 [boolean]\n  --version  Show version number                                       [boolean]\n\nember-cli-update codemods\n\nRun codemods to help update your code\n\nOptions:\n      --help                    Show help                              [boolean]\n      --version                 Show version number                    [boolean]\n  -p, --packageName, --package  Provide a package that can contain many\n                                blueprints (\"@glimmer/blueprint\",\n                                \"git+https://git@github.com/tildeio/libkit.git\",\n                                \"../blueprint\")                         [string]\n  -b, --blueprint               Provide a custom blueprint for use in the update\n                                (\"@glimmer/blueprint\",\n                                \"git+https://git@github.com/tildeio/libkit.git\",\n                                \"../blueprint\")                         [string]\n      --source-json             Supply your own codemods manifest via JSON (`{\n                                /* json */ }`)                          [string]\n      --list                    List available codemods\n                                                      [boolean] [default: false]\n\nember-cli-update compare\n\nShow the changes between different versions without updating\n\nOptions:\n      --help                    Show help                              [boolean]\n      --version                 Show version number                    [boolean]\n  -p, --packageName, --package  Provide a package that can contain many\n                                blueprints (\"@glimmer/blueprint\",\n                                \"git+https://git@github.com/tildeio/libkit.git\",\n                                \"../blueprint\")                         [string]\n  -b, --blueprint               Provide a custom blueprint for use in the update\n                                (\"@glimmer/blueprint\",\n                                \"git+https://git@github.com/tildeio/libkit.git\",\n                                \"../blueprint\")                         [string]\n      --to                      Update to a version that isn't latest (\"2.14.1\",\n                                \"~2.15\", \"latest\", \"beta\")              [string]\n\nember-cli-update init\n\ninitialize a blueprint\n\nOptions:\n      --help              Show help                                    [boolean]\n      --version           Show version number                          [boolean]\n  -b, --blueprint         Provide a custom blueprint for use in the update\n                          (\"@glimmer/blueprint\",\n                          \"git+https://git@github.com/tildeio/libkit.git\",\n                          \"../blueprint\")                               [string]\n      --to                Update to a version that isn't latest (\"2.14.1\",\n                          \"~2.15\", \"latest\", \"beta\")                    [string]\n      --resolveConflicts  Automatically run git mergetool if conflicts found\n                                                      [boolean] [default: false]\n      --outputRepo        An output repository of changes over time     [string]\n      --codemodsSource    Supply your own codemods manifest via URL\n                          (\"ember-app-codemods-manifest@*\",\n                          \"git+https://github.com/ember-cli/ember-app-codemods-m\n                          anifest.git#semver:*\")                        [string]\n\nember-cli-update install \u003caddon\u003e\n\ninstall an addon\n\nOptions:\n      --help       Show help                                           [boolean]\n      --version    Show version number                                 [boolean]\n  -b, --blueprint  Provide a custom blueprint for use in the update\n                   (\"@glimmer/blueprint\",\n                   \"git+https://git@github.com/tildeio/libkit.git\",\n                   \"../blueprint\")                                      [string]\n\nember-cli-update reset\n\nreset a blueprint\n\nOptions:\n      --help                    Show help                              [boolean]\n      --version                 Show version number                    [boolean]\n  -p, --packageName, --package  Provide a package that can contain many\n                                blueprints (\"@glimmer/blueprint\",\n                                \"git+https://git@github.com/tildeio/libkit.git\",\n                                \"../blueprint\")                         [string]\n  -b, --blueprint               Provide a custom blueprint for use in the update\n                                (\"@glimmer/blueprint\",\n                                \"git+https://git@github.com/tildeio/libkit.git\",\n                                \"../blueprint\")                         [string]\n      --to                      Update to a version that isn't latest (\"2.14.1\",\n                                \"~2.15\", \"latest\", \"beta\")              [string]\n\nember-cli-update save\n\nsave old blueprint state\n\nOptions:\n      --help                    Show help                              [boolean]\n      --version                 Show version number                    [boolean]\n  -p, --packageName, --package  Provide a package that can contain many\n                                blueprints (\"@glimmer/blueprint\",\n                                \"git+https://git@github.com/tildeio/libkit.git\",\n                                \"../blueprint\")                         [string]\n  -b, --blueprint               Provide a custom blueprint for use in the update\n                                (\"@glimmer/blueprint\",\n                                \"git+https://git@github.com/tildeio/libkit.git\",\n                                \"../blueprint\")                         [string]\n      --from                    Use a starting version that is different than\n                                what is in your package.json (\"2.9.1\")  [string]\n      --outputRepo              An output repository of changes over time\n                                                                        [string]\n      --codemodsSource          Supply your own codemods manifest via URL\n                                (\"ember-app-codemods-manifest@*\",\n                                \"git+https://github.com/ember-cli/ember-app-code\n                                mods-manifest.git#semver:*\")            [string]\n\nember-cli-update stats\n\nlist blueprint version updates\n\nOptions:\n      --help                    Show help                              [boolean]\n      --version                 Show version number                    [boolean]\n  -p, --packageName, --package  Provide a package that can contain many\n                                blueprints (\"@glimmer/blueprint\",\n                                \"git+https://git@github.com/tildeio/libkit.git\",\n                                \"../blueprint\")                         [string]\n  -b, --blueprint               Provide a custom blueprint for use in the update\n                                (\"@glimmer/blueprint\",\n                                \"git+https://git@github.com/tildeio/libkit.git\",\n                                \"../blueprint\")                         [string]\n```\n\n\u003c!-- CODEGEN_CLI_HELP --\u003e\n\n## Power User Guide\n\nLet's update from Ember CLI 2.18.2 to Ember CLI 3.1.4\n\nFirst, make sure you are on the latest ember-cli-update version for good measure.\n\n```\nnpm install -g ember-cli-update\n```\n\nThen, run all compatible codemods against your current version. Since codemods are downloaded on the fly, they can be updated (and new ones added) without even getting a new version of ember-cli-update. Also, we may add additional codemods targeting your older version of Ember.js.\n\n```\nember-cli-update --run-codemods\n```\n\nAssuming you are multiple versions behind of Ember CLI, you may want to update in stages. Unless you have a really simple app, updating in stages can help isolate upgrade issues.\n\n```\nember-cli-update --to 3.0\n```\n\nOnce you resolve conflicts and commit, You again want to run codemods. This is because new codemods targeting Ember.js 3.0 will now apply.\n\n```\nember-cli-update --run-codemods\n```\n\nNow you are ready to update again. (If your final update is going to be the latest version of Ember CLI, you don't need the `--to` option.)\n\n```\nember-cli-update --to 3.1\n```\n\nAgain, after you resolve conflicts and commit, you want to run codemods because of new Ember.js 3.1 codemods.\n\n```\nember-cli-update --run-codemods\n```\n\nAnd then you're done! You have a freshly updated app (or addon). As noted, you can consolidate these steps by doing a direct update, but then you may be confused if you encounter issues which version is to blame.\n\n## Hints\n\nNeed help using `git mergetool`? Here are some starting points:\n\n* https://git-scm.com/docs/git-mergetool\n* https://gist.github.com/karenyyng/f19ff75c60f18b4b8149\n\nIf you made a mistake during the update/conflict resolution, run these commands to undo everything and get you back to before the update:\n\n```\ngit reset --hard\ngit clean -f\n```\n\nIf you notice \".orig\" files lying around after a merge and don't want that behavior, run `git config --global mergetool.keepBackup false`.\n\nTo avoid being prompted \"Hit return to start merge resolution tool (vimdiff):\" for every conflict, set a merge tool like `git config --global merge.tool \"vimdiff\"`.\n\nIf you run into an error like `error: unrecognized input`, you may need to update your git config color option like `git config --global color.ui auto`.\n\n## Troubleshooting\n\nIf you are getting an error or unexpected results, running the command with the debug flag:\n\n* Unix (global):\u0026nbsp;\u0026nbsp;\u0026nbsp;`DEBUG=ember-cli-update,boilerplate-update,git-diff-apply ember-cli-update`\n* Windows (global):\u0026nbsp;\u0026nbsp;\u0026nbsp;`set DEBUG=ember-cli-update,boilerplate-update,git-diff-apply \u0026\u0026 ember-cli-update`\n* Unix (command):\u0026nbsp;\u0026nbsp;\u0026nbsp;`DEBUG=ember-cli-update,boilerplate-update,git-diff-apply ember update`\n* Windows (command):\u0026nbsp;\u0026nbsp;\u0026nbsp;`set DEBUG=ember-cli-update,boilerplate-update,git-diff-apply \u0026\u0026 ember update`\n\nwill give you more detailed logging.\n","funding_links":[],"categories":["Packages","Tools"],"sub_categories":["Command-line utilities","Development"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fember-cli%2Fember-cli-update","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fember-cli%2Fember-cli-update","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fember-cli%2Fember-cli-update/lists"}