Skip to content
This repository was archived by the owner on Feb 12, 2022. It is now read-only.

fixed for dev center docs #32

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion commands/authorizations/create.js
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@ module.exports = {
topic: 'authorizations',
command: 'create',
description: 'create a new OAuth authorization',
help: 'This creates an authorization with access to your Heroku account.',
needsAuth: true,
flags: [
{char: 'd', name: 'description', hasValue: true, description: 'set a custom authorization description'},
Expand All @@ -44,4 +43,15 @@ module.exports = {
{name: 'json', description: 'output in json format'}
],
run: cli.command(co.wrap(run))
help: `This creates an authorization with access to your Heroku account.

Example:

$ heroku authorizations:create
Creating OAuth Authorization... done
Client: <none>
ID: -3614-b8d5ff7a84e-febdfc45b1832-5698
Description: Long-lived user authorization
Scope: global
Token: 2-434e9-b-1e5de876512a-ad49f3f8f8f62`
}
8 changes: 7 additions & 1 deletion commands/authorizations/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -31,5 +31,11 @@ module.exports = {
flags: [
{name: 'json', description: 'output in json format'}
],
run: cli.command(co.wrap(run))
run: cli.command(co.wrap(run)),
help: `Example:

$ heroku authorizations
Heroku CLI 48e44c6bbeded530997-e284866-d6-971-9 global
Heroku CLI login from shinobi at Tue Jul 18 2017 14:30:40 GMT-0500 (CDT) d-97-de93859d-d4c904d1bcd3-650423695 global
Heroku CLI login from aragami at Mon Jun 19 2017 14:36:09 GMT-0500 (CDT) 6a83a-3b0443--de5074943feb047-aaefb9 global`
}
10 changes: 9 additions & 1 deletion commands/authorizations/info.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,5 +22,13 @@ module.exports = {
{name: 'json', description: 'output in json format'}
],
args: [{name: 'id'}],
run: cli.command(co.wrap(run))
run: cli.command(co.wrap(run)),
help: `Example:

$ heroku authorizations:info 93614-b8d5ff7a84e-febdfc45b1832-5698
Client: <none>
ID: -3614-b8d5ff7a84e-febdfc45b1832-5698
Description: Long-lived user authorization
Scope: global
Token: 2-434e9-b-1e5de876512a-ad49f3f8f8f62`
}
7 changes: 6 additions & 1 deletion commands/authorizations/revoke.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,10 @@ module.exports = {
description: 'revoke OAuth authorization',
needsAuth: true,
args: [{name: 'id'}],
run: cli.command(co.wrap(run))
run: cli.command(co.wrap(run)),
help: `Example:

$ heroku authorizations:revoke 3614-b8d5ff7a84e-febdfc45b1832-5698
Revoking OAuth Authorization...
done, revoked authorization from Long-lived user authorization`
}
5 changes: 4 additions & 1 deletion commands/clients/create.js
Original file line number Diff line number Diff line change
Expand Up @@ -40,5 +40,8 @@ module.exports = {
{name: 'shell', char: 's', description: 'output in shell format'},
{name: 'json', description: 'output in json format'}
],
run: cli.command(co.wrap(run))
run: cli.command(co.wrap(run)),
help: `Example:

$ heroku clients:create DEVAUTH https://my.authurl.suffix`
}
6 changes: 5 additions & 1 deletion commands/clients/destroy.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,9 @@ module.exports = {
description: 'delete client by ID',
needsAuth: true,
args: [{name: 'id'}],
run: cli.command(co.wrap(run))
run: cli.command(co.wrap(run)),
help: `Example:

$ heroku clients:destroy DEVAUTH
Destroying DEVAUTH... done`
}
5 changes: 4 additions & 1 deletion commands/clients/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -31,5 +31,8 @@ module.exports = {
flags: [
{name: 'json', description: 'output in json format'}
],
run: cli.command(co.wrap(run))
run: cli.command(co.wrap(run)),
help: `Example:

$ heroku clients`
}
5 changes: 4 additions & 1 deletion commands/clients/info.js
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,8 @@ module.exports = {
{name: 'json', description: 'output in json format'},
{name: 'shell', char: 's', description: 'output in shell format'}
],
run: cli.command(co.wrap(run))
run: cli.command(co.wrap(run)),
help: `Example:

$ heroku clients:info DEVAUTH`
}
5 changes: 4 additions & 1 deletion commands/clients/update.js
Original file line number Diff line number Diff line change
Expand Up @@ -37,5 +37,8 @@ module.exports = {
{name: 'url', hasValue: true, description: 'change the client redirect URL'}
],
needsAuth: true,
run: cli.command(co.wrap(run))
run: cli.command(co.wrap(run)),
help: `Example:

$ heroku clients:update DEVAUTH -n NEW_DEVAUTH`
}
6 changes: 5 additions & 1 deletion commands/sessions/destroy.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,9 @@ module.exports = {
description: 'delete (logout) OAuth session by ID',
needsAuth: true,
args: [{name: 'id'}],
run: cli.command(co.wrap(run))
run: cli.command(co.wrap(run)),
help: `Example:

$ heroku sessions:destroy e4-c4f6b98d0d-57ca40279ef36c4-d-312b
Destroying 2e3eac53-b82c-4a46-8c0e-e2edd404c1c8... done`
}
11 changes: 10 additions & 1 deletion commands/sessions/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -30,5 +30,14 @@ module.exports = {
flags: [
{name: 'json', description: 'output in json format'}
],
run: cli.command(co.wrap(run))
run: cli.command(co.wrap(run)),
help: `Example:

$ heroku sessions
Session @ 12.34.56.789 e4-c4f6b98d0d-57ca40279ef36c4-d-310
Session @ 12.34.56.789 e4-c4f6b98d0d-57ca40279ef36c4-d-312
Session @ 12.34.56.789 e4-c4f6b98d0d-57ca40279ef36c4-d-313
Session @ 12.34.56.789 e4-c4f6b98d0d-57ca40279ef36c4-d-314
Session @ 12.34.56.789 e4-c4f6b98d0d-57ca40279ef36c4-d-319
Session @ 12.34.56.789 e4-c4f6b98d0d-57ca40279ef36c4-d-311`
}