Installation

GitHub Local Actions can be installed directly from the Extensions view in Visual Studio Code or using either the VS Code Marketplace or Open VSX Registry.

VS Code Marketplace

Open VSX Registry

Component Installation

nektos/act

nektos/act the is the CLI tool which will be used for actually running your workflows locally. This component can be installed from the Components view or manually using the instructions here.

Docker Engine

Docker Engine API is required for nektos/act if you plan to run workflows in containers. This component should be manually installed using the instructions here.

Caution

If you do not require container isolation, you can run selected (e.g. Windows or MacOS) workflow jobs directly on your system. In this case, you do not need to have docker installed or running. Click here to learn how to use your host system as your runner.

Recommended Extensions

It is recommended to install the extensions below as they provide additional functionality that complement GitHub Local Actions.

GitHub Actions Edit workflow files easily with the help of syntax highlighting, integrated documentation, code completion and workflow validation.