Skip to main content

app config link

Pulls app configuration from the Developer Dashboard and creates or overwrites a configuration file. You can create a new app with this command to start with a default configuration file.

For more information on the format of the created TOML configuration file, refer to the App configuration page.

The following flags are available for the app config link command:

Anchor to --auth-alias <value>
--auth-alias <value>
string
env: SHOPIFY_FLAG_AUTH_ALIAS

Alias of the Shopify account to use for authentication.

Anchor to --client-id <value>
--client-id <value>
string
env: SHOPIFY_FLAG_CLIENT_ID

The Client ID of the remote app to link. Use --file-name to specify the destination configuration file. Required if non interactive.

Anchor to --file-name <value>
--file-name <value>
string
env: SHOPIFY_FLAG_APP_CONFIG_FILE_NAME

The name of the app configuration file to create or overwrite. Requires --force to overwrite an existing file.

Anchor to --force
--force
env: SHOPIFY_FLAG_FORCE

Overwrite an existing configuration file without prompting.

Anchor to --json-schema
--json-schema
env: SHOPIFY_FLAG_JSON_SCHEMA

Print the command's JSON schemas.

Anchor to --no-color
--no-color
env: SHOPIFY_FLAG_NO_COLOR

Disable color output.

Anchor to --no-input
--no-input
env: SHOPIFY_FLAG_NO_INPUT

Disable interactive prompts and browser authentication.

Anchor to --path <value>
--path <value>
string
env: SHOPIFY_FLAG_PATH

The path to your app directory.

Anchor to --reset
--reset
env: SHOPIFY_FLAG_RESET

Reset all your settings.

Anchor to --verbose
--verbose
env: SHOPIFY_FLAG_VERBOSE

Increase the verbosity of the output. May include sensitive data.

Anchor to -c, --config <value>
-c, --config <value>
string
env: SHOPIFY_FLAG_APP_CONFIG

The name of the local app configuration to read and overwrite. Use --file-name instead when specifying --client-id.

Examples

app config link

shopify app config link [flags]

Was this page helpful?