app security instructions

Prints the workflow that a coding agent follows to review your app's security: run app security check, investigate the checks that can't be determined by code inspection alone, record its findings with app security record, and show the combined results with app security review.

The workflow starts with a fresh scan. It doesn't need an earlier app security check or reuse its options: the instructions tell your agent to decide what to scan, such as extra directories to add with --include-dir, and then run the check itself. Use this command to hand your agent the whole workflow at any time, to copy it to your clipboard, or to write it to a file.

Use --path, --config, --client-id, and --without-app-config to select the app. The commands in the instructions use the same selection.

Anchor to flagsFlags

The following flags are available for the app security instructions command:

Anchor to --client-id <value> --client-id <value> string env: SHOPIFY_FLAG_CLIENT_ID: The Client ID of your app.
Anchor to --copy --copy env: SHOPIFY_FLAG_APP_SECURITY_INSTRUCTIONS_COPY: Copy the instructions to the clipboard instead of printing them.
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 --verbose --verbose env: SHOPIFY_FLAG_VERBOSE: Increase the verbosity of the output. May include sensitive data.
Anchor to --without-app-config --without-app-config env: SHOPIFY_FLAG_WITHOUT_APP_CONFIG: Scan --path as an app with no app configuration file. Config checks are skipped. Requires --client-id.
Anchor to --write <value> --write <value> string env: SHOPIFY_FLAG_APP_SECURITY_INSTRUCTIONS_WRITE: Write the instructions to a file instead of printing them.
Anchor to -c, --config <value> -c, --config <value> string env: SHOPIFY_FLAG_APP_CONFIG: The name of the app configuration.

Examples