toolbelt.heroku.comThe Heroku CLI | Heroku Dev Center

Skip Navigation Show nav Heroku Dev Center Get Started Documentation Changelog Search Get Started Node.js Ruby on Rails Ruby Python Java PHP Go Scala Clojure Documentation Changelog More Additional Resources Home Elements Products Pricing Careers Help Status Events Podcasts Compliance Center Heroku Blog Heroku Blog Find out what's new with Heroku on our blog. Visit Blog Log in or Sign up View categories Categories Heroku Architecture Dynos (app containers) Stacks (operating system images) Networking & DNS Platform Policies Platform Principles Command Line Deployment Deploying with Git Deploying with Docker Deployment Integrations Continuous Delivery Continuous Integration Language Support Node.js Ruby Working with Bundler Rails Support Python Working with Django Background Jobs in Python Java Working with Maven Java Database Operations Working with the Play Framework Java Advanced Topics Working with Spring Boot PHP Go Go Dependency Management Scala Clojure Databases & Data Management Heroku Postgres Postgres Basics Postgres Performance Postgres Data Transfer & Preservation Postgres Availability Postgres Special Topics Heroku Redis Apache Kafka on Heroku Other Data Stores Monitoring & Metrics Logging App Performance Add-ons All Add-ons Collaboration Security App Security Identities & Authentication Compliance Heroku Enterprise Private Spaces Infrastructure Networking Enterprise Accounts Enterprise Teams Heroku Connect (Salesforce sync) Single Sign-on (SSO) Patterns & Best Practices Extending Heroku Platform API App Webhooks Heroku Labs Building Add-ons Add-on Development Tasks Add-on APIs Add-on Guidelines & Requirements Building CLI Plugins Developing Buildpacks Dev Center Accounts & Billing Troubleshooting & Support Command Line The Heroku CLI The Heroku CLI English — 日本語に切り替える Last updated April 27, 2021 Table of Contents Download and install Other installation methods Verifying your installation Getting started Staying up to date Useful CLI plugins CLI architecture Troubleshooting Uninstalling the Heroku CLI The Heroku Command Line Interface (CLI) makes it easy to create and manage your Heroku apps directly from the terminal. It’s an essential part of using Heroku. Download and install The Heroku CLI requires Git , the popular version control system. If you don’t already have Git installed, complete the following before installing the CLI: Git installation First-time Git setup Currently, the Windows installers may display a warning titled “Windows protected your PC”. To run the installation when this warning is shown, click “More info”, verify the publisher as “salesforce.com, inc”, then click the “Run anyway” button. macOS $ brew tap heroku/brew && brew install heroku Windows Download the appropriate installer for your Windows installation: 64-bit installer 32-bit installer Ubuntu 16+ Run the following from your terminal: $ sudo snap install --classic heroku Snap is available on other Linux OS’s as well . Other installation methods Standalone installation The standalone install is a simple tarball with a binary. It contains its own node.js binary and will autoupdate like the above install methods. To quickly setup into /usr/local/lib/heroku and /usr/local/bin/heroku , run this script (script requires sudo and not Windows compatible): $ curl https://cli-assets.heroku.com/install.sh | sh Otherwise, download one of the tarballs below and extract it yourself. Tarballs These are available in gz or xz compression. xz is much smaller but gz is more compatible. macOS Linux (x64) Linux (arm) Windows (x64) Windows (x86) Ubuntu / Debian apt-get $ curl https://cli-assets.heroku.com/install-ubuntu.sh | sh This version does not autoupdate and must be updated manually via apt-get . Use the snap or standalone installation for an autoupdating version of the CLI. Arch Linux This package is community maintained and not by Heroku. $ yay -S heroku-cli npm The CLI is built with Node.js and is installable via npm . This is a manual install method that can be used in environments where autoupdating is not ideal or where Heroku does not offer a prebuilt Node.js binary. It’s strongly recommended to use one of the other installation methods if possible. This installation method does not autoupdate and requires you to use your system’s version of Node.js, which may be older than the version Heroku develops the CLI against. Heroku uses very current releases of Node.js and does not back-support older versions. If you use any of the other installation methods the proper version of Node.js is already included, and it doesn’t conflict with any other version on your system. Also, this method won’t use the yarn lockfile for dependencies like the others do (even if you install with yarn). This may cause issues if the CLI’s dependencies become incompatible in minor or patch releases. This method is useful if you want fine-grained control over CLI updates such as in a tested script. This installation method is required for users on ARM and BSD. You must have node and npm installed already. $ npm install -g heroku Verifying your installation To verify your CLI installation, use the heroku --version command: $ heroku --version heroku/7.0.0 (darwin-x64) node-v8.0.0 You should see heroku/x.y.z in the output. If you don’t, but you have installed the Heroku CLI, it’s possible you have an old heroku gem on your system. Uninstall it with these instructions . Getting started After you install the CLI, run the heroku login command. You’ll be prompted to enter any key to go to your web browser to complete login. The CLI will then log you in automatically. $ heroku login heroku: Press any key to open up the browser to login or q to exit › Warning: If browser does not open, visit › https://cli-auth.heroku.com/auth/browser/*** heroku: Waiting for login... Logging in... done Logged in as me@example.com If you’d prefer to stay in the CLI to enter your credentials, you may run heroku login -i $ heroku login -i heroku: Enter your login credentials Email: me@example.com Password: *************** Two-factor code: ******** Logged in as me@heroku.com The CLI saves your email address and an API token to ~/.netrc for future use. For more information, see Heroku CLI Authentication . Now you’re ready to create your first Heroku app: $ cd ~/myapp $ heroku create Creating app... done, ⬢ sleepy-meadow-81798 https://sleepy-meadow-81798.herokuapp.com/ | https://git.heroku.com/sleepy-meadow-81798.git Check out your preferred language’s getting started guide for a comprehensive introduction to deploying your first app. Staying up to date The Heroku CLI keeps itself and its plugins (except linked plugins) up to date automatically, unless you installed the Debian/Ubuntu package or used npm install . When you run a heroku command, a background process checks for the latest available version of the CLI. If a new version is found, it’s downloaded and stored in ~/.local/share/heroku/client . This background check happens at most once every 4 hours. The heroku binary checks for an up-to-date client in ~/.local/share/heroku/client before using the originally installed client. Latest release SHAs Darwin x64 Linux arm x64 Windows x64 x86 Useful CLI plugins CLI plugins allow you to extend your CLI installation. Install a CLI plugin with heroku plugins:install someplugin . See Using CLI Plugins for more information on plugin management. Here are some useful plugins you might want to try: heroku-builds — View builds, purge the build cache, and create builds from tarballs heroku-repo — Commands to manipulate an app’s Heroku git repository api — Make ad-hoc API requests (such as heroku api GET /account ) heroku-pg-extras — Add extra heroku pg:* commands heroku-slugs — Downloads app slugs heroku-kafka — Manage Heroku Kafka heroku-papertrail — Display, tail, and search for logs with Papertrail CLI architecture The Heroku CLI is built with the Open CLI Framework ( oclif ), developed with...