1 | heroku-cli-plugin-apps
|
2 | ======================
|
3 |
|
4 | [![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
|
5 | [![Version](https://img.shields.io/npm/v/heroku-cli-plugin-apps.svg)](https://npmjs.org/package/heroku-cli-plugin-apps)
|
6 | [![CircleCI](https://circleci.com/gh/brettgoulder/heroku-cli-plugin-apps/tree/master.svg?style=shield)](https://circleci.com/gh/brettgoulder/heroku-cli-plugin-apps/tree/master)
|
7 | [![Downloads/week](https://img.shields.io/npm/dw/heroku-cli-plugin-apps.svg)](https://npmjs.org/package/heroku-cli-plugin-apps)
|
8 | [![License](https://img.shields.io/npm/l/heroku-cli-plugin-apps.svg)](https://github.com/brettgoulder/heroku-cli-plugin-apps/blob/master/package.json)
|
9 |
|
10 |
|
11 | * [Usage](#usage)
|
12 | * [Commands](#commands)
|
13 |
|
14 | # Usage
|
15 |
|
16 | ```sh-session
|
17 | $ npm install -g @heroku-cli/plugin-apps
|
18 | $ heroku COMMAND
|
19 | running command...
|
20 | $ heroku (-v|--version|version)
|
21 | @heroku-cli/plugin-apps/7.53.0 darwin-x64 node-v12.14.1
|
22 | $ heroku --help [COMMAND]
|
23 | USAGE
|
24 | $ heroku COMMAND
|
25 | ...
|
26 | ```
|
27 |
|
28 | # Commands
|
29 |
|
30 | * [`heroku domains`](#heroku-domains)
|
31 | * [`heroku domains:add HOSTNAME`](#heroku-domainsadd-hostname)
|
32 | * [`heroku domains:clear`](#heroku-domainsclear)
|
33 | * [`heroku domains:info HOSTNAME`](#heroku-domainsinfo-hostname)
|
34 | * [`heroku domains:remove HOSTNAME`](#heroku-domainsremove-hostname)
|
35 | * [`heroku domains:update [HOSTNAME]`](#heroku-domainsupdate-hostname)
|
36 | * [`heroku domains:wait [HOSTNAME]`](#heroku-domainswait-hostname)
|
37 |
|
38 | ## `heroku domains`
|
39 |
|
40 | list domains for an app
|
41 |
|
42 | ```
|
43 | USAGE
|
44 | $ heroku domains
|
45 |
|
46 | OPTIONS
|
47 | -a, --app=app (required) app to run command against
|
48 | -h, --help show CLI help
|
49 | -j, --json output in json format
|
50 | -r, --remote=remote git remote of app to use
|
51 | -x, --extended show extra columns
|
52 | --columns=columns only show provided columns (comma-separated)
|
53 | --csv output is csv format
|
54 | --filter=filter filter property by partial string matching, ex: name=foo
|
55 | --no-header hide table header from output
|
56 | --sort=sort property to sort by (prepend '-' for descending)
|
57 |
|
58 | EXAMPLES
|
59 | $ heroku domains
|
60 | === example Heroku Domain
|
61 | example.herokuapp.com
|
62 |
|
63 | === example Custom Domains
|
64 | Domain Name DNS Record Type DNS Target
|
65 | www.example.com CNAME www.example.herokudns.com
|
66 |
|
67 | $ heroku domains --filter 'Domain Name=www.example.com'
|
68 | ```
|
69 |
|
70 | _See code: [src/commands/domains/index.ts](https://github.com/heroku/heroku-cli-plugin-apps/blob/v7.53.0/src/commands/domains/index.ts)_
|
71 |
|
72 | ## `heroku domains:add HOSTNAME`
|
73 |
|
74 | add a domain to an app
|
75 |
|
76 | ```
|
77 | USAGE
|
78 | $ heroku domains:add HOSTNAME
|
79 |
|
80 | OPTIONS
|
81 | -a, --app=app (required) app to run command against
|
82 | -c, --cert=cert the name of the SSL cert you want to use for this domain
|
83 | -h, --help show CLI help
|
84 | -j, --json output in json format
|
85 | -r, --remote=remote git remote of app to use
|
86 | --wait
|
87 |
|
88 | EXAMPLE
|
89 | heroku domains:add www.example.com
|
90 | ```
|
91 |
|
92 | _See code: [src/commands/domains/add.ts](https://github.com/heroku/heroku-cli-plugin-apps/blob/v7.53.0/src/commands/domains/add.ts)_
|
93 |
|
94 | ## `heroku domains:clear`
|
95 |
|
96 | remove all domains from an app
|
97 |
|
98 | ```
|
99 | USAGE
|
100 | $ heroku domains:clear
|
101 |
|
102 | OPTIONS
|
103 | -a, --app=app (required) app to run command against
|
104 | -h, --help show CLI help
|
105 | -r, --remote=remote git remote of app to use
|
106 |
|
107 | EXAMPLE
|
108 | heroku domains:clear
|
109 | ```
|
110 |
|
111 | _See code: [src/commands/domains/clear.ts](https://github.com/heroku/heroku-cli-plugin-apps/blob/v7.53.0/src/commands/domains/clear.ts)_
|
112 |
|
113 | ## `heroku domains:info HOSTNAME`
|
114 |
|
115 | show detailed information for a domain on an app
|
116 |
|
117 | ```
|
118 | USAGE
|
119 | $ heroku domains:info HOSTNAME
|
120 |
|
121 | OPTIONS
|
122 | -a, --app=app (required) app to run command against
|
123 | -h, --help show CLI help
|
124 | -r, --remote=remote git remote of app to use
|
125 |
|
126 | EXAMPLE
|
127 | $ heroku domains:info www.example.com
|
128 | ```
|
129 |
|
130 | _See code: [src/commands/domains/info.ts](https://github.com/heroku/heroku-cli-plugin-apps/blob/v7.53.0/src/commands/domains/info.ts)_
|
131 |
|
132 | ## `heroku domains:remove HOSTNAME`
|
133 |
|
134 | remove a domain from an app
|
135 |
|
136 | ```
|
137 | USAGE
|
138 | $ heroku domains:remove HOSTNAME
|
139 |
|
140 | OPTIONS
|
141 | -a, --app=app (required) app to run command against
|
142 | -h, --help show CLI help
|
143 | -r, --remote=remote git remote of app to use
|
144 |
|
145 | EXAMPLE
|
146 | heroku domains:remove www.example.com
|
147 | ```
|
148 |
|
149 | _See code: [src/commands/domains/remove.ts](https://github.com/heroku/heroku-cli-plugin-apps/blob/v7.53.0/src/commands/domains/remove.ts)_
|
150 |
|
151 | ## `heroku domains:update [HOSTNAME]`
|
152 |
|
153 | update a domain to use a different SSL certificate on an app
|
154 |
|
155 | ```
|
156 | USAGE
|
157 | $ heroku domains:update [HOSTNAME]
|
158 |
|
159 | OPTIONS
|
160 | -a, --app=app (required) app to run command against
|
161 | -h, --help show CLI help
|
162 | -r, --remote=remote git remote of app to use
|
163 | --cert=cert (required) the name or id of the certificate you want to use for this domain
|
164 |
|
165 | EXAMPLE
|
166 | heroku domains:update www.example.com --cert mycert
|
167 | ```
|
168 |
|
169 | _See code: [src/commands/domains/update.ts](https://github.com/heroku/heroku-cli-plugin-apps/blob/v7.53.0/src/commands/domains/update.ts)_
|
170 |
|
171 | ## `heroku domains:wait [HOSTNAME]`
|
172 |
|
173 | wait for domain to be active for an app
|
174 |
|
175 | ```
|
176 | USAGE
|
177 | $ heroku domains:wait [HOSTNAME]
|
178 |
|
179 | OPTIONS
|
180 | -a, --app=app (required) app to run command against
|
181 | -h, --help show CLI help
|
182 | -r, --remote=remote git remote of app to use
|
183 | ```
|
184 |
|
185 | _See code: [src/commands/domains/wait.ts](https://github.com/heroku/heroku-cli-plugin-apps/blob/v7.53.0/src/commands/domains/wait.ts)_
|
186 |
|