Skip to content
play

GitHub Action

setup-nucleus-cli

v1.0.4 Latest version

setup-nucleus-cli

play

setup-nucleus-cli

Setup Nucleus CLI, on GitHub Actions runners

Installation

Copy and paste the following snippet into your .yml file.

              

- name: setup-nucleus-cli

uses: nucleuscloud/setup-nucleus-cli-action@v1.0.4

Learn more about this action in nucleuscloud/setup-nucleus-cli-action

Choose a version

GitHub release GitHub marketplace Test workflow

setup-nucleus-cli-action

The nucleuscloud/setup-nucleus-cli-action is a Typescript action that sets up Nucleus CLI in your GitHub Actions workflow.

  • Downloads a specific version of Nucleus CLI and adds it to the PATH.
  • Handling Nucleus authentication using Nucleus service account.

After you've used the action, subsequent steps in the same job can run Nucleus commands using the GitHub Actions run syntax. This allows Nucleus commands to work like they do on your local command line.

Usage

Nucleus CLI

Download Nucleus CLI and not authenticate with Nucleus.

name: ci

on:
  push:
    branches: main

jobs:
  login:
    runs-on: ubuntu-latest
    steps:
      - name: Download Nucleus CLI
        uses: nucleuscloud/setup-nucleus-cli-action@v1

Set up a Nucleus service account in order to authenticate against Nucleus CLI. When client id and client secret included the github action will handle login.

name: ci

on:
  push:
    branches: main

jobs:
  login:
    runs-on: ubuntu-latest
    steps:
      - name: Download Nucleus CLI & Login
        uses: nucleuscloud/setup-nucleus-cli-action@v1
        with:
          version: 0.0.26
          client_id: ${{ secrets.CLIENT_ID }}
          client_secret: ${{ secrets.CLIENT_SECRET }}
      - name: 'Use nucleus CLI'
        run: 'nucleus -h'

Customizing

inputs

Name Type Default Required Description
version String latest false Nucleus CLI version
client_id String false Client id for logging into Nucleus
client_secret String false Client secret for logging into Nucleus
logout boolean true false Logout from Nucleus at end of a job