The Run MATLAB Command action enables you to execute MATLAB® scripts, functions, and statements on a GitHub®-hosted or self-hosted runner:

• To use a GitHub-hosted runner, include the Setup MATLAB action in your workflow to set up your preferred MATLAB release (R2021a or later) on the runner.
• To use a self-hosted runner, set up a computer with MATLAB on its path and register the runner with GitHub Actions. (On self-hosted UNIX® runners, you can also use the Setup MATLAB action instead of having MATLAB already installed.) The runner uses the topmost MATLAB release on the system path to execute your workflow.

Use the Run MATLAB Command action to run MATLAB scripts, functions, and statements. You can use this action to flexibly customize your test run or add a step in MATLAB to your workflow.

On a self-hosted runner that has MATLAB installed, run a script named myscript.m in the root of your repository. To run the script, specify the Run MATLAB Command action in your workflow.

name: Run MATLAB Script
on: [push]
jobs:
    my-job:
        name: Run MATLAB Script
        runs-on: self-hosted
        steps:
            - name: Check out repository
              uses: actions/checkout@v7
            - name: Run script
              uses: matlab-actions/run-command@v3
              with:
                  command: myscript

Using the latest release of MATLAB on a GitHub-hosted runner, run your MATLAB statements. To set up the latest release of MATLAB on the runner, specify the Setup MATLAB action in your workflow. To run the statements, specify the Run MATLAB Command action.

name: Run MATLAB Statements
on: [push]
jobs:
    my-job:
        name: Run MATLAB Statements
        runs-on: ubuntu-latest
        steps:
            - name: Check out repository
              uses: actions/checkout@v7
            - name: Set up MATLAB
              uses: matlab-actions/setup-matlab@v3
            - name: Run statements
              uses: matlab-actions/run-command@v3
              with:
                  command: results = runtests, assertSuccess(results);

When you define a workflow using the Setup MATLAB action, you need a MATLAB batch licensing token if your project is private or if your workflow uses transformation products, such as MATLAB Coder™ and MATLAB Compiler™. Batch licensing tokens are strings that enable MATLAB to start in noninteractive environments. You can request a token by submitting the MATLAB Batch Licensing Pilot form.

To use a MATLAB batch licensing token:

1. Set the token as a secret. For more information about secrets, see Using secrets in GitHub Actions.
2. Map the secret to an environment variable named MLM_LICENSE_TOKEN in your workflow.

For example, use the latest release of MATLAB on a GitHub-hosted runner to run a script named myscript.m in your private project. To set up the latest release of MATLAB on the runner, specify the Setup MATLAB action in your workflow. To run the script, specify the Run MATLAB Command action. In this example, MyToken is the name of the secret that holds the batch licensing token.

name: Use MATLAB Batch Licensing Token
on: [push]
env:
  MLM_LICENSE_TOKEN: ${{ secrets.MyToken }}
jobs:
  my-job:
    name: Run MATLAB Script in Private Project
    runs-on: ubuntu-latest
    steps:
      - name: Check out repository
        uses: actions/checkout@v7
      - name: Set up MATLAB
        uses: matlab-actions/setup-matlab@v3
      - name: Run script
        uses: matlab-actions/run-command@v3
        with:
          command: myscript

When you define your workflow in the .github/workflows directory of your repository, specify the Run MATLAB Command action as matlab-actions/run-command@v3. The action requires an input and also accepts optional inputs.

When you use this action, all of the required files must be on the MATLAB search path. If your script or function is not in the root of your repository, you can use the addpath, cd, or run function to put it on the path. For example, to run myscript.m in a folder named myfolder located in the root of the repository, you can specify command like this:

command: addpath("myfolder"), myscript

• By default, when you use the Run MATLAB Command action, the root of your repository serves as the MATLAB startup folder. To run your MATLAB commands using a different folder, specify the -sd startup option or the cd command in the action.
• In MATLAB R2019a and later, the Run MATLAB Command action uses the -batch option to start MATLAB noninteractively. MATLAB settings do not persist across different MATLAB sessions launched with the -batch option. To run code that requires the same settings, use a single action.
• When you use the Run MATLAB Command action, you execute third-party code that is licensed under separate terms.

• Action for Running MATLAB Builds
• Action for Running MATLAB Tests
• Action for Setting Up MATLAB
• Continuous Integration with MATLAB and Simulink

If you encounter a product licensing issue, consider requesting a MATLAB batch licensing token to use in your workflow. For more information, see Use MATLAB Batch Licensing Token.

If you have an enhancement request or other feedback about this action, create an issue on the Issues page.

For support, contact MathWorks Technical Support.