# function-runner

**Repository Path**: mirrors_Shopify/function-runner

## Basic Information

- **Project Name**: function-runner
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-06-17
- **Last Updated**: 2026-01-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# function-runner

[About this repo](#about-this-repo) | [Usage](#usage) | [Development](#development)

## About this repo

**Introduction:**

This is a simple CLI (`function-runner`) which allows you to run Wasm
Functions intended for the Shopify Functions infrastructure. Functions will run using
the provided JSON input file and their output will be printed as JSON
upon completion.

By default, the Function is expected to be named `function.wasm` in the
current directory. This may be overriden using the `-f` option.

Example: `function-runner -f '../my-function-name.wasm' -i '../my-input.json'`

## Usage

If you wish to use `function-runner` without compiling it, the [Releases](https://github.com/Shopify/function-runner/releases) page
contains binaries that can be run on your computer.

To see the list of possible commands and arguments, run `function-runner --help`.

## Development

Building requires a rust toolchain of `1.66.0` to `1.67.0`. `cargo install --path . --locked` will build
and add the `function-runner` command to your path.

### Commands

- `cargo install --path . --locked` : Build and install the `function-runner` command.
- `function-runner` : Execute a Function.

## Releasing

1. Create and merge a PR incrementing the version in [Cargo.toml](https://github.com/Shopify/function-runner/blob/main/Cargo.toml#L11) in accordance with [SemVer](https://semver.org/) based on changes from the previous release
1. Create a new release in [Github](https://github.com/Shopify/function-runner/releases/new) with a name like `v3.2.3` where the version matches the Cargo.toml version
    - **:warning: Warning: If you create a draft release, the [GitHub action](https://github.com/Shopify/function-runner/actions/workflows/publish.yml) to generate the binary assets _will not_ be automatically run. You will need to manually run the action.**