Home

Awesome

dfinity/setup-dfx

The dfinity/setup-dfx repository provides a GitHub Action to set up the dfx software development kit (SDK) for Internet Computer.

Usage

To use this action in your GitHub workflow, include it as a step in your workflow configuration:

jobs:
  example-job:
    runs-on: ubuntu-latest 
    steps:
    - name: Checkout repository
      uses: actions/checkout@v2
    - name: Install dfx
      uses: dfinity/setup-dfx@main
    - name: Confirm successful installation
      run: dfx --version

The action is designed to run on both ubuntu- and macos- runners.

Specifying a dfx Version

You can specify a particular version of dfx to install using the dfx-version input:

    - name: Install dfx
      uses: dfinity/setup-dfx@main
      with: 
        dfx-version: "0.14.2-beta.2"

Inputs

InputDescription
dfx-version(Optional) The version of dfx to install. If "auto" (the default), the version will be taken from dfx.json if present, otherwise latest. If "latest", the latest version will be installed.

Contributing

Contributions to the dfinity/setup-dfx repository are welcome!

License

This project is licensed under the Apache 2.0 License.