@heroku-cli/plugin-applink

Heroku AppLink plugin

• @heroku-cli/plugin-applink
• Usage
• Commands

Usage

$ heroku plugins:install @heroku-cli/plugin-applink
$ heroku applink:COMMAND
running command...
$ heroku applink --help [COMMAND]
USAGE
  $ heroku applink:COMMAND
...

Commands

• heroku applink:authorizations
• heroku applink:authorizations:info DEVELOPER_NAME
• heroku applink:connections
• heroku applink:connections:info CONNECTION_NAME
• heroku datacloud:connect [CONNECTION_NAME]
• heroku datacloud:data-action-target:create LABEL
• heroku datacloud:disconnect CONNECTION_NAME
• heroku salesforce:authorizations:add DEVELOPER_NAME
• heroku salesforce:authorizations:remove DEVELOPER_NAME
• heroku salesforce:connect CONNECTION_NAME
• heroku salesforce:disconnect CONNECTION_NAME
• heroku salesforce:publications
• heroku salesforce:publish API_SPEC_FILE_DIR

heroku applink:authorizations

list Heroku AppLink authorized users

USAGE
  $ heroku applink:authorizations -a <value> [--addon <value>] [-r <value>]

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use
      --addon=<value>   unique name or ID of an AppLink add-on

DESCRIPTION
  list Heroku AppLink authorized users

See code: src/commands/applink/authorizations/index.ts

heroku applink:authorizations:info DEVELOPER_NAME

show info for a Heroku AppLink authorized user

USAGE
  $ heroku applink:authorizations:info DEVELOPER_NAME -a <value> [--addon <value>] [-r <value>]

ARGUMENTS
  DEVELOPER_NAME  developer name of the authorization

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use
      --addon=<value>   unique name or ID of an AppLink add-on

DESCRIPTION
  show info for a Heroku AppLink authorized user

See code: src/commands/applink/authorizations/info.ts

heroku applink:connections

list Heroku AppLink connections

USAGE
  $ heroku applink:connections -a <value> [--addon <value>] [-r <value>]

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use
      --addon=<value>   unique name or ID of an AppLink add-on

DESCRIPTION
  list Heroku AppLink connections

See code: src/commands/applink/connections/index.ts

heroku applink:connections:info CONNECTION_NAME

show info for a Heroku AppLink connection

USAGE
  $ heroku applink:connections:info CONNECTION_NAME -a <value> [--addon <value>] [-r <value>]

ARGUMENTS
  CONNECTION_NAME  name of the connected org

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use
      --addon=<value>   unique name or ID of an AppLink add-on

DESCRIPTION
  show info for a Heroku AppLink connection

See code: src/commands/applink/connections/info.ts

heroku datacloud:connect [CONNECTION_NAME]

connect a Data Cloud org to a Heroku app

USAGE
  $ heroku datacloud:connect [CONNECTION_NAME] -a <value> [--addon <value>] [--browser <value>] [-l <value>] [-r
    <value>]

ARGUMENTS
  CONNECTION_NAME  name for the Data Cloud connection. Must begin with a letter, end with a letter or a number, and
                   between 3-30 characters. Only alphanumeric characters and non-consecutive underscores ('_') are
                   allowed.

FLAGS
  -a, --app=<value>        (required) app to run command against
  -l, --login-url=<value>  Salesforce login URL
  -r, --remote=<value>     git remote of app to use
      --addon=<value>      unique name or ID of an AppLink add-on
      --browser=<value>    browser to open OAuth flow with (example: "firefox", "safari")

DESCRIPTION
  connect a Data Cloud org to a Heroku app

See code: src/commands/datacloud/connect.ts

heroku datacloud:data-action-target:create LABEL

create a Data Cloud data action target for a Heroku app

USAGE
  $ heroku datacloud:data-action-target:create LABEL -a <value> -o <value> -p <value> [--addon <value>] [-n <value>] [-t WebHook] [-r
    <value>]

ARGUMENTS
  LABEL  label for the data action target. Must begin with a letter, end with a letter or a number, and between 3-30
         characters. Only alphanumeric characters and non-consecutive underscores ('_') are allowed.

FLAGS
  -a, --app=<value>              (required) app to run command against
  -n, --api-name=<value>         [default: <LABEL>] API name for the data action target
  -o, --connection-name=<value>  (required) Data Cloud connection namee to create the data action target
  -p, --target-api-path=<value>  (required) API path for the data action target excluding app URL, eg "/" or
                                 "/handleDataCloudDataChangeEvent"
  -r, --remote=<value>           git remote of app to use
  -t, --type=<option>            [default: WebHook] Data action target type
                                 <options: WebHook>
      --addon=<value>            unique name or ID of an AppLink add-on

DESCRIPTION
  create a Data Cloud data action target for a Heroku app

See code: src/commands/datacloud/data-action-target/create.ts

heroku datacloud:disconnect CONNECTION_NAME

disconnect a Data Cloud org from a Heroku app

USAGE
  $ heroku datacloud:disconnect CONNECTION_NAME -a <value> [--addon <value>] [-c <value>] [-r <value>]

ARGUMENTS
  CONNECTION_NAME  name of the Data Cloud connection

FLAGS
  -a, --app=<value>      (required) app to run command against
  -c, --confirm=<value>  set to Data Cloud org connection name to bypass confirm prompt
  -r, --remote=<value>   git remote of app to use
      --addon=<value>    unique name or ID of an AppLink add-on

DESCRIPTION
  disconnect a Data Cloud org from a Heroku app

See code: src/commands/datacloud/disconnect.ts

heroku salesforce:authorizations:add DEVELOPER_NAME

store a user's credentials for connecting a Salesforce Org to a Heroku app

USAGE
  $ heroku salesforce:authorizations:add DEVELOPER_NAME -a <value> [--addon <value>] [--browser <value>] [-l <value>]
  [-r <value>]

ARGUMENTS
  DEVELOPER_NAME  developer name for the authorization. Must begin with a letter, end with a letter or a number, and
                  between 3-30 characters. Only alphanumeric characters and non-consecutive underscores ('_') are
                  allowed.

FLAGS
  -a, --app=<value>        (required) app to run command against
  -l, --login-url=<value>  Salesforce login URL
  -r, --remote=<value>     git remote of app to use
      --addon=<value>      unique name or ID of an AppLink add-on
      --browser=<value>    browser to open OAuth flow with (example: "firefox", "safari")

DESCRIPTION
  store a user's credentials for connecting a Salesforce Org to a Heroku app

See code: src/commands/salesforce/authorizations/add.ts

heroku salesforce:authorizations:remove DEVELOPER_NAME

remove a Salesforce authorization from a Heroku app

USAGE
  $ heroku salesforce:authorizations:remove DEVELOPER_NAME -a <value> [--addon <value>] [-c <value>] [-r <value>]

ARGUMENTS
  DEVELOPER_NAME  developer name of the Salesforce authorization

FLAGS
  -a, --app=<value>      (required) app to run command against
  -c, --confirm=<value>  set to developer name to bypass confirm prompt
  -r, --remote=<value>   git remote of app to use
      --addon=<value>    unique name or ID of an AppLink add-on

DESCRIPTION
  remove a Salesforce authorization from a Heroku app

See code: src/commands/salesforce/authorizations/remove.ts

heroku salesforce:connect CONNECTION_NAME

connect a Salesforce org to a Heroku app

USAGE
  $ heroku salesforce:connect CONNECTION_NAME -a <value> [--addon <value>] [--browser <value>] [-l <value>] [-r <value>]

ARGUMENTS
  CONNECTION_NAME  name for the Salesforce connection.  Must begin with a letter, end with a letter or a number, and be
                   between 3-30 characters. Only alphanumeric characters and non-consecutive underscores ('_') are
                   allowed.

FLAGS
  -a, --app=<value>        (required) app to run command against
  -l, --login-url=<value>  login URL
  -r, --remote=<value>     git remote of app to use
      --addon=<value>      unique name or ID of an AppLink add-on
      --browser=<value>    browser to open OAuth flow with (example: "firefox", "safari")

DESCRIPTION
  connect a Salesforce org to a Heroku app

See code: src/commands/salesforce/connect/index.ts

heroku salesforce:disconnect CONNECTION_NAME

disconnect a Salesforce connection from a Heroku app

USAGE
  $ heroku salesforce:disconnect CONNECTION_NAME -a <value> [--addon <value>] [-c <value>] [-r <value>]

ARGUMENTS
  CONNECTION_NAME  name of the Salesforce connection you would like to disconnect

FLAGS
  -a, --app=<value>      (required) app to run command against
  -c, --confirm=<value>  set to Salesforce connection name to bypass confirm prompt
  -r, --remote=<value>   git remote of app to use
      --addon=<value>    unique name or ID of an AppLink add-on

DESCRIPTION
  disconnect a Salesforce connection from a Heroku app

See code: src/commands/salesforce/disconnect.ts

heroku salesforce:publications

list Salesforce orgs the app is published to

USAGE
  $ heroku salesforce:publications -a <value> [--addon <value>] [--connection_name <value>] [-r <value>]

FLAGS
  -a, --app=<value>              (required) app to run command against
  -r, --remote=<value>           git remote of app to use
      --addon=<value>            unique name or ID of an AppLink add-on
      --connection_name=<value>  name of the Salesforce connection

DESCRIPTION
  list Salesforce orgs the app is published to

See code: src/commands/salesforce/publications.ts

heroku salesforce:publish API_SPEC_FILE_DIR

publish an app's API specification to an authenticated Salesforce org

USAGE
  $ heroku salesforce:publish API_SPEC_FILE_DIR -a <value> -c <value> --connection-name <value> [--addon <value>]
    [--authorization-connected-app-name <value>] [--authorization-permission-set-name <value>] [--metadata-dir <value>]
    [-r <value>]

ARGUMENTS
  API_SPEC_FILE_DIR  path to OpenAPI 3.x spec file (JSON or YAML format)

FLAGS
  -a, --app=<value>                                (required) app to run command against
  -c, --client-name=<value>                        (required) name given to the client stub
  -r, --remote=<value>                             git remote of app to use
      --addon=<value>                              unique name or ID of an AppLink add-on
      --authorization-connected-app-name=<value>   name of connected app to create from our template
      --authorization-permission-set-name=<value>  name of permission set to create from our template
      --connection-name=<value>                    (required) authenticated Salesforce connection name
      --metadata-dir=<value>                       directory containing connected app, permission set, or API spec

DESCRIPTION
  publish an app's API specification to an authenticated Salesforce org

See code: src/commands/salesforce/publish.ts