Skip to content

Commit

Permalink
fix: updated monorepo documentation urls
Browse files Browse the repository at this point in the history
  • Loading branch information
jdx committed Jun 20, 2018
1 parent ed347bd commit 4bb6fe0
Show file tree
Hide file tree
Showing 31 changed files with 112,930 additions and 2,373 deletions.
14 changes: 7 additions & 7 deletions docs/auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ ALIASES
$ heroku twofactor
```

_See code: [@heroku-cli/plugin-auth](https://github.com/heroku/cli/blob/v7.4.0/src/commands/auth/2fa.ts)_
_See code: [@heroku-cli/plugin-auth](https://github.com/heroku/cli/blob/v7.4.0/packages/auth/src/commands/auth/2fa.ts)_

## `heroku auth:2fa:disable`

Expand All @@ -43,7 +43,7 @@ EXAMPLES
Disabling 2fa on me@example.com... done
```

_See code: [@heroku-cli/plugin-auth](https://github.com/heroku/cli/blob/v7.4.0/src/commands/auth/2fa/disable.ts)_
_See code: [@heroku-cli/plugin-auth](https://github.com/heroku/cli/blob/v7.4.0/packages/auth/src/commands/auth/2fa/disable.ts)_

## `heroku auth:2fa:generate-recovery-codes`

Expand Down Expand Up @@ -82,7 +82,7 @@ EXAMPLES
f82e7c2a50737494
```

_See code: [@heroku-cli/plugin-auth](https://github.com/heroku/cli/blob/v7.4.0/src/commands/auth/2fa/generate-recovery-codes.ts)_
_See code: [@heroku-cli/plugin-auth](https://github.com/heroku/cli/blob/v7.4.0/packages/auth/src/commands/auth/2fa/generate-recovery-codes.ts)_

## `heroku auth:login`

Expand All @@ -102,7 +102,7 @@ ALIASES
$ heroku login
```

_See code: [@heroku-cli/plugin-auth](https://github.com/heroku/cli/blob/v7.4.0/src/commands/auth/login.ts)_
_See code: [@heroku-cli/plugin-auth](https://github.com/heroku/cli/blob/v7.4.0/packages/auth/src/commands/auth/login.ts)_

## `heroku auth:logout`

Expand All @@ -116,7 +116,7 @@ ALIASES
$ heroku logout
```

_See code: [@heroku-cli/plugin-auth](https://github.com/heroku/cli/blob/v7.4.0/src/commands/auth/logout.ts)_
_See code: [@heroku-cli/plugin-auth](https://github.com/heroku/cli/blob/v7.4.0/packages/auth/src/commands/auth/logout.ts)_

## `heroku auth:token`

Expand All @@ -134,7 +134,7 @@ DESCRIPTION
authorizations:create
```

_See code: [@heroku-cli/plugin-auth](https://github.com/heroku/cli/blob/v7.4.0/src/commands/auth/token.ts)_
_See code: [@heroku-cli/plugin-auth](https://github.com/heroku/cli/blob/v7.4.0/packages/auth/src/commands/auth/token.ts)_

## `heroku auth:whoami`

Expand All @@ -148,4 +148,4 @@ ALIASES
$ heroku whoami
```

_See code: [@heroku-cli/plugin-auth](https://github.com/heroku/cli/blob/v7.4.0/src/commands/auth/whoami.ts)_
_See code: [@heroku-cli/plugin-auth](https://github.com/heroku/cli/blob/v7.4.0/packages/auth/src/commands/auth/whoami.ts)_
140 changes: 98 additions & 42 deletions docs/certs.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,18 @@
a topic for the ssl plugin

* [`heroku certs`](#heroku-certs)
* [`heroku certs:add [CRT] [KEY]`](#heroku-certsadd-crt-key)
* [`heroku certs:add CRT KEY`](#heroku-certsadd-crt-key)
* [`heroku certs:auto`](#heroku-certsauto)
* [`heroku certs:auto:disable`](#heroku-certsautodisable)
* [`heroku certs:auto:enable`](#heroku-certsautoenable)
* [`heroku certs:auto:refresh`](#heroku-certsautorefresh)
* [`heroku certs:chain`](#heroku-certschain)
* [`heroku certs:generate [DOMAIN]`](#heroku-certsgenerate-domain)
* [`heroku certs:generate DOMAIN`](#heroku-certsgenerate-domain)
* [`heroku certs:info`](#heroku-certsinfo)
* [`heroku certs:key`](#heroku-certskey)
* [`heroku certs:remove`](#heroku-certsremove)
* [`heroku certs:rollback`](#heroku-certsrollback)
* [`heroku certs:update [CRT] [KEY]`](#heroku-certsupdate-crt-key)
* [`heroku certs:update CRT KEY`](#heroku-certsupdate-crt-key)

## `heroku certs`

Expand All @@ -24,22 +24,31 @@ list SSL certificates for an app
```
USAGE
$ heroku certs
OPTIONS
-a, --app=app (required) app to run command against
-r, --remote=remote git remote of app to use
```

_See code: [@heroku-cli/plugin-certs-v5](https://github.com/heroku/cli/blob/v7.4.2/commands/certs.js)_
_See code: [@heroku-cli/plugin-certs-v5](https://github.com/heroku/cli/blob/v7.4.2/packages/certs-v5/commands/certs.js)_

## `heroku certs:add [CRT] [KEY]`
## `heroku certs:add CRT KEY`

add an SSL certificate to an app

```
USAGE
$ heroku certs:add [CRT] [KEY]
$ heroku certs:add CRT KEY
OPTIONS
--0 bypass the trust chain completion step
--1 type to create, either 'sni' or 'endpoint'
--2 domains to create after certificate upload
-a, --app=app (required) app to run command against
-r, --remote=remote git remote of app to use
--bypass bypass the trust chain completion step
--domains=domains domains to create after certificate upload
--type=type type to create, either 'sni' or 'endpoint'
DESCRIPTION
Note: certificates with PEM encoding are also valid
EXAMPLES
$ heroku certs:add example.com.crt example.com.key
Expand All @@ -48,7 +57,7 @@ EXAMPLES
$ heroku certs:add intermediary.crt example.com.crt example.com.key
```

_See code: [@heroku-cli/plugin-certs-v5](https://github.com/heroku/cli/blob/v7.4.2/commands/certs/add.js)_
_See code: [@heroku-cli/plugin-certs-v5](https://github.com/heroku/cli/blob/v7.4.2/packages/certs-v5/commands/certs/add.js)_

## `heroku certs:auto`

Expand All @@ -57,9 +66,13 @@ show ACM status for an app
```
USAGE
$ heroku certs:auto
OPTIONS
-a, --app=app (required) app to run command against
-r, --remote=remote git remote of app to use
```

_See code: [@heroku-cli/plugin-certs-v5](https://github.com/heroku/cli/blob/v7.4.2/commands/certs/auto.js)_
_See code: [@heroku-cli/plugin-certs-v5](https://github.com/heroku/cli/blob/v7.4.2/packages/certs-v5/commands/certs/auto.js)_

## `heroku certs:auto:disable`

Expand All @@ -68,9 +81,13 @@ disable ACM for an app
```
USAGE
$ heroku certs:auto:disable
OPTIONS
-a, --app=app (required) app to run command against
-r, --remote=remote git remote of app to use
```

_See code: [@heroku-cli/plugin-certs-v5](https://github.com/heroku/cli/blob/v7.4.2/commands/certs/auto/disable.js)_
_See code: [@heroku-cli/plugin-certs-v5](https://github.com/heroku/cli/blob/v7.4.2/packages/certs-v5/commands/certs/auto/disable.js)_

## `heroku certs:auto:enable`

Expand All @@ -79,9 +96,13 @@ enable ACM status for an app
```
USAGE
$ heroku certs:auto:enable
OPTIONS
-a, --app=app (required) app to run command against
-r, --remote=remote git remote of app to use
```

_See code: [@heroku-cli/plugin-certs-v5](https://github.com/heroku/cli/blob/v7.4.2/commands/certs/auto/enable.js)_
_See code: [@heroku-cli/plugin-certs-v5](https://github.com/heroku/cli/blob/v7.4.2/packages/certs-v5/commands/certs/auto/enable.js)_

## `heroku certs:auto:refresh`

Expand All @@ -90,9 +111,13 @@ refresh ACM for an app
```
USAGE
$ heroku certs:auto:refresh
OPTIONS
-a, --app=app (required) app to run command against
-r, --remote=remote git remote of app to use
```

_See code: [@heroku-cli/plugin-certs-v5](https://github.com/heroku/cli/blob/v7.4.2/commands/certs/auto/refresh.js)_
_See code: [@heroku-cli/plugin-certs-v5](https://github.com/heroku/cli/blob/v7.4.2/packages/certs-v5/commands/certs/auto/refresh.js)_

## `heroku certs:chain`

Expand All @@ -101,33 +126,45 @@ print an ordered & complete chain for a certificate
```
USAGE
$ heroku certs:chain
OPTIONS
-a, --app=app (required) app to run command against
-r, --remote=remote git remote of app to use
```

_See code: [@heroku-cli/plugin-certs-v5](https://github.com/heroku/cli/blob/v7.4.2/commands/certs/chain.js)_
_See code: [@heroku-cli/plugin-certs-v5](https://github.com/heroku/cli/blob/v7.4.2/packages/certs-v5/commands/certs/chain.js)_

## `heroku certs:generate [DOMAIN]`
## `heroku certs:generate DOMAIN`

generate a key and a CSR or self-signed certificate

```
USAGE
$ heroku certs:generate [DOMAIN]
$ heroku certs:generate DOMAIN
OPTIONS
--0 generate a self-signed certificate instead of a CSR
--1 RSA key size in bits (default: 2048)
--2 name of organization certificate belongs to
--3 country of owner, as a two-letter ISO country code
--4 sub-country area (state, province, etc.) of owner
--5 city of owner
--6 specify entire certificate subject
--7 do not prompt for any owner information
-a, --app=app (required) app to run command against
-r, --remote=remote git remote of app to use
--area=area sub-country area (state, province, etc.) of owner
--city=city city of owner
--country=country country of owner, as a two-letter ISO country code
--keysize=keysize RSA key size in bits (default: 2048)
--now do not prompt for any owner information
--owner=owner name of organization certificate belongs to
--selfsigned generate a self-signed certificate instead of a CSR
--subject=subject specify entire certificate subject
DESCRIPTION
Generate a key and certificate signing request (or self-signed certificate)
for an app. Prompts for information to put in the certificate unless --now
is used, or at least one of the --subject, --owner, --country, --area, or
--city options is specified.
EXAMPLES
$ heroku certs:generate example.com
```

_See code: [@heroku-cli/plugin-certs-v5](https://github.com/heroku/cli/blob/v7.4.2/commands/certs/generate.js)_
_See code: [@heroku-cli/plugin-certs-v5](https://github.com/heroku/cli/blob/v7.4.2/packages/certs-v5/commands/certs/generate.js)_

## `heroku certs:info`

Expand All @@ -138,11 +175,13 @@ USAGE
$ heroku certs:info
OPTIONS
--0 name to check info on
--1 endpoint to check info on
-a, --app=app (required) app to run command against
-r, --remote=remote git remote of app to use
--endpoint=endpoint endpoint to check info on
--name=name name to check info on
```

_See code: [@heroku-cli/plugin-certs-v5](https://github.com/heroku/cli/blob/v7.4.2/commands/certs/info.js)_
_See code: [@heroku-cli/plugin-certs-v5](https://github.com/heroku/cli/blob/v7.4.2/packages/certs-v5/commands/certs/info.js)_

## `heroku certs:key`

Expand All @@ -152,11 +191,19 @@ print the correct key for the given certificate
USAGE
$ heroku certs:key
OPTIONS
-a, --app=app (required) app to run command against
-r, --remote=remote git remote of app to use
DESCRIPTION
You must pass one single certificate, and one or more keys.
The first key that signs the certificate will be printed back.
EXAMPLES
$ heroku certs:key example.com.crt example.com.key
```

_See code: [@heroku-cli/plugin-certs-v5](https://github.com/heroku/cli/blob/v7.4.2/commands/certs/key.js)_
_See code: [@heroku-cli/plugin-certs-v5](https://github.com/heroku/cli/blob/v7.4.2/packages/certs-v5/commands/certs/key.js)_

## `heroku certs:remove`

Expand All @@ -167,11 +214,13 @@ USAGE
$ heroku certs:remove
OPTIONS
--1 name to remove
--2 endpoint to remove
-a, --app=app (required) app to run command against
-r, --remote=remote git remote of app to use
--endpoint=endpoint endpoint to remove
--name=name name to remove
```

_See code: [@heroku-cli/plugin-certs-v5](https://github.com/heroku/cli/blob/v7.4.2/commands/certs/remove.js)_
_See code: [@heroku-cli/plugin-certs-v5](https://github.com/heroku/cli/blob/v7.4.2/packages/certs-v5/commands/certs/remove.js)_

## `heroku certs:rollback`

Expand All @@ -182,24 +231,31 @@ USAGE
$ heroku certs:rollback
OPTIONS
--1 name to rollback
--2 endpoint to rollback
-a, --app=app (required) app to run command against
-r, --remote=remote git remote of app to use
--endpoint=endpoint endpoint to rollback
--name=name name to rollback
```

_See code: [@heroku-cli/plugin-certs-v5](https://github.com/heroku/cli/blob/v7.4.2/commands/certs/rollback.js)_
_See code: [@heroku-cli/plugin-certs-v5](https://github.com/heroku/cli/blob/v7.4.2/packages/certs-v5/commands/certs/rollback.js)_

## `heroku certs:update [CRT] [KEY]`
## `heroku certs:update CRT KEY`

update an SSL certificate on an app

```
USAGE
$ heroku certs:update [CRT] [KEY]
$ heroku certs:update CRT KEY
OPTIONS
--0 bypass the trust chain completion step
--2 name to update
--3 endpoint to update
-a, --app=app (required) app to run command against
-r, --remote=remote git remote of app to use
--bypass bypass the trust chain completion step
--endpoint=endpoint endpoint to update
--name=name name to update
DESCRIPTION
Note: certificates with PEM encoding are also valid
EXAMPLES
$ heroku certs:update example.com.crt example.com.key
Expand All @@ -208,4 +264,4 @@ EXAMPLES
$ heroku certs:update intermediary.crt example.com.crt example.com.key
```

_See code: [@heroku-cli/plugin-certs-v5](https://github.com/heroku/cli/blob/v7.4.2/commands/certs/update.js)_
_See code: [@heroku-cli/plugin-certs-v5](https://github.com/heroku/cli/blob/v7.4.2/packages/certs-v5/commands/certs/update.js)_
6 changes: 3 additions & 3 deletions docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ OPTIONS
-s, --shell output config vars in shell format
```

_See code: [@heroku-cli/plugin-config](https://github.com/heroku/cli/blob/v7.4.0/src/commands/config.ts)_
_See code: [@heroku-cli/plugin-config](https://github.com/heroku/cli/blob/v7.4.0/packages/config/src/commands/config.ts)_

## `heroku config:edit [KEY]`

Expand Down Expand Up @@ -56,7 +56,7 @@ EXAMPLES
$ VISUAL="atom --wait" heroku config:edit
```

_See code: [@heroku-cli/plugin-config](https://github.com/heroku/cli/blob/v7.4.0/src/commands/config/edit.ts)_
_See code: [@heroku-cli/plugin-config](https://github.com/heroku/cli/blob/v7.4.0/packages/config/src/commands/config/edit.ts)_

## `heroku config:get KEY...`

Expand All @@ -76,7 +76,7 @@ EXAMPLES
production
```

_See code: [@heroku-cli/plugin-config](https://github.com/heroku/cli/blob/v7.4.0/src/commands/config/get.ts)_
_See code: [@heroku-cli/plugin-config](https://github.com/heroku/cli/blob/v7.4.0/packages/config/src/commands/config/get.ts)_

## `heroku config:set`

Expand Down
4 changes: 2 additions & 2 deletions docs/git.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ EXAMPLES
...
```

_See code: [@heroku-cli/plugin-git](https://github.com/heroku/cli/blob/v7.4.0/src/commands/git/clone.ts)_
_See code: [@heroku-cli/plugin-git](https://github.com/heroku/cli/blob/v7.4.0/packages/git/src/commands/git/clone.ts)_

## `heroku git:remote`

Expand All @@ -55,4 +55,4 @@ EXAMPLES
$ heroku git:remote --remote heroku-staging -a example
```

_See code: [@heroku-cli/plugin-git](https://github.com/heroku/cli/blob/v7.4.0/src/commands/git/remote.ts)_
_See code: [@heroku-cli/plugin-git](https://github.com/heroku/cli/blob/v7.4.0/packages/git/src/commands/git/remote.ts)_
2 changes: 1 addition & 1 deletion docs/labs.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ OPTIONS
--confirm=confirm
```

_See code: [@heroku-cli/plugin-auth](https://github.com/heroku/cli/blob/v7.4.0/src/commands/labs/disable.ts)_
_See code: [@heroku-cli/plugin-auth](https://github.com/heroku/cli/blob/v7.4.0/packages/auth/src/commands/labs/disable.ts)_

## `heroku labs:enable FEATURE`

Expand Down
Loading

0 comments on commit 4bb6fe0

Please sign in to comment.