Skip to content

domains.md

Latest commit

 

History

History
214 lines (151 loc) · 5.79 KB

domains.md

File metadata and controls

214 lines (151 loc) · 5.79 KB

heroku domains

custom domains for apps

heroku domains

list domains for an app

USAGE
  $ heroku domains -a <value> [--prompt] [--columns <value>] [-c] [-x] [--filter <value>] [-j] [--no-wrap]
    [-r <value>] [--sort <value>]

FLAGS
  -a, --app=<value>      (required) app to run command against
  -c, --csv              output in csv format
  -j, --json             output in json format
  -r, --remote=<value>   git remote of app to use
  -x, --extended         show extra columns
      --columns=<value>  only show provided columns (comma-separated)
      --filter=<value>   filter property by partial string matching, ex: name=foo
      --no-wrap          disable wrapped table cells for easier copy/paste
      --sort=<value>     sort by property

GLOBAL FLAGS
  --prompt  interactively prompt for command arguments and flags

DESCRIPTION
  list domains for an app

EXAMPLES
   $ heroku domains 
  === example Heroku Domain
  example-xxxxxxxxxxxx.herokuapp.com
  === example Custom Domains
  Domain Name      DNS Record Type  DNS Target
  www.example.com  CNAME            www.example.herokudns.com

   $ heroku domains --filter 'Domain Name=www.example.com' 
  === example Custom Domains
  Domain Name      DNS Record Type  DNS Target
  www.example.com  CNAME            www.example.herokudns.com

See code: src/commands/domains/index.ts

heroku domains:add HOSTNAME

add a domain to an app

USAGE
  $ heroku domains:add HOSTNAME -a <value> [--prompt] [-c <value>] [-j] [-r <value>] [--wait]

ARGUMENTS
  HOSTNAME  unique identifier of the domain or full hostname

FLAGS
  -a, --app=<value>     (required) app to run command against
  -c, --cert=<value>    the name of the SSL cert you want to use for this domain
  -j, --json            output in json format
  -r, --remote=<value>  git remote of app to use
  --wait

GLOBAL FLAGS
  --prompt  interactively prompt for command arguments and flags

DESCRIPTION
  add a domain to an app

EXAMPLES
   $ heroku domains:add www.example.com

See code: src/commands/domains/add.ts

heroku domains:clear

remove all domains from an app

USAGE
  $ heroku domains:clear -a <value> [--prompt] [-r <value>]

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use

GLOBAL FLAGS
  --prompt  interactively prompt for command arguments and flags

DESCRIPTION
  remove all domains from an app

EXAMPLES
   $ heroku domains:clear

See code: src/commands/domains/clear.ts

heroku domains:info HOSTNAME

show detailed information for a domain on an app

USAGE
  $ heroku domains:info HOSTNAME -a <value> [--prompt] [-r <value>]

ARGUMENTS
  HOSTNAME  unique identifier of the domain or full hostname

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use

GLOBAL FLAGS
  --prompt  interactively prompt for command arguments and flags

DESCRIPTION
  show detailed information for a domain on an app

EXAMPLES
   $ heroku domains:info www.example.com

See code: src/commands/domains/info.ts

heroku domains:remove HOSTNAME

remove a domain from an app

USAGE
  $ heroku domains:remove HOSTNAME -a <value> [--prompt] [-r <value>]

ARGUMENTS
  HOSTNAME  unique identifier of the domain or full hostname

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use

GLOBAL FLAGS
  --prompt  interactively prompt for command arguments and flags

DESCRIPTION
  remove a domain from an app

EXAMPLES
   $ heroku domains:remove www.example.com

See code: src/commands/domains/remove.ts

heroku domains:update HOSTNAME

update a domain to use a different SSL certificate on an app

USAGE
  $ heroku domains:update HOSTNAME -a <value> --cert <value> [--prompt] [-r <value>]

ARGUMENTS
  HOSTNAME  unique identifier of the domain or full hostname

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use
      --cert=<value>    (required) the name or id of the certificate you want to use for this domain

GLOBAL FLAGS
  --prompt  interactively prompt for command arguments and flags

DESCRIPTION
  update a domain to use a different SSL certificate on an app

EXAMPLES
   $ heroku domains:update www.example.com --cert mycert

See code: src/commands/domains/update.ts

heroku domains:wait [HOSTNAME]

wait for domain to be active for an app

USAGE
  $ heroku domains:wait [HOSTNAME] -a <value> [--prompt] [-r <value>]

ARGUMENTS
  [HOSTNAME]  unique identifier of the domain or full hostname

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use

GLOBAL FLAGS
  --prompt  interactively prompt for command arguments and flags

DESCRIPTION
  wait for domain to be active for an app

See code: src/commands/domains/wait.ts