Skip to main content

​
Description

Executes a custom script defined in your project’s warp.yml configuration file. Scripts run on a GitHub Actions runner agent and results are posted as a comment on the issue. View in Knowledge Base

​
Examples

​
Basic (no arguments):

​
With Arguments:

​
With Boolean Flags:

​
Arguments

​
script_id (Required)

  • The identifier of the script to run, as defined in your project’s warp.yml configuration under the scripts: key.
Value:
  • Must match a script identifier configured in warp.yml.

​
—script_args (Optional)

  • Arguments to pass to the script. Provide space-separated key=value pairs after the --script_args flag. Boolean flags (without a value) are set to "true".
Value:
  • Space-separated key=value pairs.
  • Arguments must match those defined in the script’s arguments configuration in warp.yml. Unknown arguments are rejected.
  • Required arguments (as configured in warp.yml) must be provided.

​
Authorization

  • When script policies are configured in warp.yml under policies.scripts, only the listed users and teams can execute the script.
  • When no script policies are defined, all members of the repository’s organization can run all scripts.
See Custom Scripts for configuration details.