Installing AutoRest on Windows, MacOS or Linux involves two steps:
-
Install Node.js (12.19.x LTS preferred. May not function with Node < 10.x.)
if you want an easy way to install and update Node, I recommend NVS - Node Version Switcher or NVM - Node Version Manager
-
Install AutoRest using
npm
# Depending on your configuration you may need to be elevated or root to run this. (on OSX/Linux use 'sudo' )
npm install -g autorest
# run using command 'autorest' to check if installation worked
autorest --help
- To confirm you are using AutoRest V3, and not an older version, run
autorest --help
, and confirm your core version is 3.0 and higher. We strongly recommend version3.06318
or higher due to bug fixes. For more versioning information, see here.
- If you're running into issues running AutoRest, check out our troubleshooting docs
To update AutoRest if you have previous versions installed, please run:
autorest --latest
or
# Removes all other versions and plugins and installs the latest autorest-core
autorest --reset
For more information, run autorest --help
If you must fall back to AutoRest V2, run
# install the previous stable package from npm
npm install -g autorest@previous
# run using command 'autorest' to check if installation worked
autorest --help