app function run

command

appfunctionrun

• --client-id <value>

  The Client ID of your app.

  string

• --no-color

  Disable color output.

  ""

• --path <value>

  The path to your function directory.

  string

• --reset

  Reset all your settings.

  ""

• --verbose

  Increase the verbosity of the output.

  ""

• -c, --config <value>

  The name of the app configuration.

  string

• -e, --export <value>

  Name of the WebAssembly export to invoke.

  string

• -i, --input <value>

  The input JSON to pass to the function. If omitted, standard input is used.

  string

• -j, --json

  Output the result as JSON.

  ""

export interface appfunctionrun {
  /**
   * The Client ID of your app.
   * @environment SHOPIFY_FLAG_CLIENT_ID
   */
  '--client-id <value>'?: string

  /**
   * The name of the app configuration.
   * @environment SHOPIFY_FLAG_APP_CONFIG
   */
  '-c, --config <value>'?: string

  /**
   * Name of the WebAssembly export to invoke.
   * @environment SHOPIFY_FLAG_EXPORT
   */
  '-e, --export <value>'?: string

  /**
   * The input JSON to pass to the function. If omitted, standard input is used.
   * @environment SHOPIFY_FLAG_INPUT
   */
  '-i, --input <value>'?: string

  /**
   * Output the result as JSON.
   * @environment SHOPIFY_FLAG_JSON
   */
  '-j, --json'?: ''

  /**
   * Disable color output.
   * @environment SHOPIFY_FLAG_NO_COLOR
   */
  '--no-color'?: ''

  /**
   * The path to your function directory.
   * @environment SHOPIFY_FLAG_PATH
   */
  '--path <value>'?: string

  /**
   * Reset all your settings.
   * @environment SHOPIFY_FLAG_RESET
   */
  '--reset'?: ''

  /**
   * Increase the verbosity of the output.
   * @environment SHOPIFY_FLAG_VERBOSE
   */
  '--verbose'?: ''
}