UNPKG

5.35 kBMarkdownView Raw
1@heroku-cli/plugin-buildpacks
2=============================
3
4
5
6[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
7[![Version](https://img.shields.io/npm/v/@heroku-cli/plugin-buildpacks.svg)](https://npmjs.org/package/@heroku-cli/plugin-buildpacks)
8
9[![CircleCI](https://circleci.com/gh/heroku/cli/tree/master.svg?style=shield)](https://circleci.com/gh/heroku/cli/tree/master)
10
11[![Appveyor CI](https://ci.appveyor.com/api/projects/status/github/heroku/cli?branch=master&svg=true)](https://ci.appveyor.com/project/heroku/cli/branch/master)
12[![Downloads/week](https://img.shields.io/npm/dw/@heroku-cli/plugin-buildpacks.svg)](https://npmjs.org/package/@heroku-cli/plugin-buildpacks)
13[![License](https://img.shields.io/npm/l/@heroku-cli/plugin-buildpacks.svg)](https://github.com/heroku/cli/blob/master/package.json)
14
15<!-- toc -->
16* [Usage](#usage)
17* [Commands](#commands)
18<!-- tocstop -->
19# Usage
20<!-- usage -->
21```sh-session
22$ npm install -g @heroku-cli/plugin-buildpacks
23$ heroku COMMAND
24running command...
25$ heroku (-v|--version|version)
26@heroku-cli/plugin-buildpacks/7.68.0 darwin-x64 node-v16.14.0
27$ heroku --help [COMMAND]
28USAGE
29 $ heroku COMMAND
30...
31```
32<!-- usagestop -->
33# Commands
34<!-- commands -->
35* [`heroku buildpacks`](#heroku-buildpacks)
36* [`heroku buildpacks:add BUILDPACK`](#heroku-buildpacksadd-buildpack)
37* [`heroku buildpacks:clear`](#heroku-buildpacksclear)
38* [`heroku buildpacks:info BUILDPACK`](#heroku-buildpacksinfo-buildpack)
39* [`heroku buildpacks:remove [BUILDPACK]`](#heroku-buildpacksremove-buildpack)
40* [`heroku buildpacks:search [TERM]`](#heroku-buildpackssearch-term)
41* [`heroku buildpacks:set BUILDPACK`](#heroku-buildpacksset-buildpack)
42* [`heroku buildpacks:versions BUILDPACK`](#heroku-buildpacksversions-buildpack)
43
44## `heroku buildpacks`
45
46display the buildpacks for an app
47
48```
49USAGE
50 $ heroku buildpacks
51
52OPTIONS
53 -a, --app=app (required) app to run command against
54 -r, --remote=remote git remote of app to use
55```
56
57_See code: [src/commands/buildpacks/index.ts](https://github.com/heroku/cli/blob/v7.68.0/packages/buildpacks/src/commands/buildpacks/index.ts)_
58
59## `heroku buildpacks:add BUILDPACK`
60
61add new app buildpack, inserting into list of buildpacks if necessary
62
63```
64USAGE
65 $ heroku buildpacks:add BUILDPACK
66
67ARGUMENTS
68 BUILDPACK namespace/name of the buildpack
69
70OPTIONS
71 -a, --app=app (required) app to run command against
72 -i, --index=index the 1-based index of the URL in the list of URLs
73 -r, --remote=remote git remote of app to use
74```
75
76_See code: [src/commands/buildpacks/add.ts](https://github.com/heroku/cli/blob/v7.68.0/packages/buildpacks/src/commands/buildpacks/add.ts)_
77
78## `heroku buildpacks:clear`
79
80clear all buildpacks set on the app
81
82```
83USAGE
84 $ heroku buildpacks:clear
85
86OPTIONS
87 -a, --app=app (required) app to run command against
88 -r, --remote=remote git remote of app to use
89```
90
91_See code: [src/commands/buildpacks/clear.ts](https://github.com/heroku/cli/blob/v7.68.0/packages/buildpacks/src/commands/buildpacks/clear.ts)_
92
93## `heroku buildpacks:info BUILDPACK`
94
95fetch info about a buildpack
96
97```
98USAGE
99 $ heroku buildpacks:info BUILDPACK
100
101ARGUMENTS
102 BUILDPACK namespace/name of the buildpack
103```
104
105_See code: [src/commands/buildpacks/info.ts](https://github.com/heroku/cli/blob/v7.68.0/packages/buildpacks/src/commands/buildpacks/info.ts)_
106
107## `heroku buildpacks:remove [BUILDPACK]`
108
109remove a buildpack set on the app
110
111```
112USAGE
113 $ heroku buildpacks:remove [BUILDPACK]
114
115ARGUMENTS
116 BUILDPACK namespace/name of the buildpack
117
118OPTIONS
119 -a, --app=app (required) app to run command against
120 -i, --index=index the 1-based index of the URL to remove from the list of URLs
121 -r, --remote=remote git remote of app to use
122```
123
124_See code: [src/commands/buildpacks/remove.ts](https://github.com/heroku/cli/blob/v7.68.0/packages/buildpacks/src/commands/buildpacks/remove.ts)_
125
126## `heroku buildpacks:search [TERM]`
127
128search for buildpacks
129
130```
131USAGE
132 $ heroku buildpacks:search [TERM]
133
134ARGUMENTS
135 TERM search term that searches across name, namespace, and description
136
137OPTIONS
138 --description=description buildpack description to filter on
139 --name=name buildpack names to filter on using a comma separated list
140 --namespace=namespace buildpack namespaces to filter on using a comma separated list
141```
142
143_See code: [src/commands/buildpacks/search.ts](https://github.com/heroku/cli/blob/v7.68.0/packages/buildpacks/src/commands/buildpacks/search.ts)_
144
145## `heroku buildpacks:set BUILDPACK`
146
147```
148USAGE
149 $ heroku buildpacks:set BUILDPACK
150
151ARGUMENTS
152 BUILDPACK namespace/name of the buildpack
153
154OPTIONS
155 -a, --app=app (required) app to run command against
156 -i, --index=index the 1-based index of the URL in the list of URLs
157 -r, --remote=remote git remote of app to use
158```
159
160_See code: [src/commands/buildpacks/set.ts](https://github.com/heroku/cli/blob/v7.68.0/packages/buildpacks/src/commands/buildpacks/set.ts)_
161
162## `heroku buildpacks:versions BUILDPACK`
163
164list versions of a buildpack
165
166```
167USAGE
168 $ heroku buildpacks:versions BUILDPACK
169
170ARGUMENTS
171 BUILDPACK namespace/name of the buildpack
172```
173
174_See code: [src/commands/buildpacks/versions.ts](https://github.com/heroku/cli/blob/v7.68.0/packages/buildpacks/src/commands/buildpacks/versions.ts)_
175<!-- commandsstop -->