https://github.com/heroku/heroku-buildpack-cli

Classic buildpack that installs the Heroku CLI.
https://github.com/heroku/heroku-buildpack-cli

heroku heroku-buildpack heroku-cli

Last synced: 6 months ago
JSON representation

Classic buildpack that installs the Heroku CLI.

• Host: GitHub
• URL: https://github.com/heroku/heroku-buildpack-cli
• Owner: heroku
• License: mit
• Created: 2017-06-15T22:03:27.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2024-01-28T15:12:17.000Z (almost 2 years ago)
• Last Synced: 2025-06-10T04:08:47.398Z (7 months ago)
• Topics: heroku, heroku-buildpack, heroku-cli
• Language: Shell
• Homepage:
• Size: 31.3 KB
• Stars: 42
• Watchers: 89
• Forks: 30
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

README

          
Heroku buildpack: Heroku CLI

=========================

This is a [Heroku buildpack](http://devcenter.heroku.com/articles/buildpacks) that

allows one to run the Heroku CLI in a dyno alongside application code.

This is not a replacement for the [Heroku API](https://devcenter.heroku.com/articles/platform-api-reference#overview) or various clients like [v3 Ruby](https://github.com/heroku/platform-api), [node](https://www.npmjs.org/package/heroku-client) or [python](https://github.com/heroku/heroku.py). Some private APIs like `pgbackups` do require the buildpack, so this exists.

Usage

-----

Example usage:

    $ heroku config:set HEROKU_API_KEY=`heroku auth:token`

    $ heroku buildpacks:add heroku-community/cli

    $ git push heroku master

    ...

    remote: -----> heroku-cli app detected

    remote: === Fetching and vendoring Heroku CLI into slug

    remote: === Installing profile.d script

    remote: === Heroku CLI installation done

    ...

    $ heroku run 'heroku auth:token'

    Running `heroku auth:token` attached to terminal... up, run.3706

    abcdef0123456789abcdef0123456789abcdef01

    $ heroku run 'heroku pgbackups:capture SILVER -a myapp'

    Running `heroku pgbackups:capture SILVER -a myapp` attached to terminal... up, run.9532

    HEROKU_POSTGRESQL_SILVER_URL  ----backup--->  b003

    Capturing... done

    Storing... done

    

The `heroku-community/cli` from the [Buildpack Registry](https://devcenter.heroku.com/articles/buildpack-registry) contains the latest stable version of the buildpack. To use the edge version of the buildpack (i.e. the source code in this repository) run this command instead:

    $ heroku buildpacks:add https://github.com/heroku/heroku-buildpack-cli

Notes

-----

Instead of setting HEROKU_API_KEY directly on the app as shown above, a short lived token may be passed in at run time:

```

heroku run "HEROKU_API_KEY=`heroku authorizations:create --expires-in 600 --short` heroku pgbackups:capture SILVER -a myapp" -a myapp

```