https://github.com/workos/cli-action

GitHub Action for installing the WorkOS CLI
https://github.com/workos/cli-action

Last synced: 4 months ago
JSON representation

GitHub Action for installing the WorkOS CLI

• Host: GitHub
• URL: https://github.com/workos/cli-action
• Owner: workos
• License: apache-2.0
• Created: 2024-07-29T21:57:26.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2025-02-15T00:32:50.000Z (over 1 year ago)
• Last Synced: 2025-04-11T15:12:19.790Z (about 1 year ago)
• Language: JavaScript
• Size: 1.24 MB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Install WorkOS CLI Github Action

Adds [WorkOS CLI](https://github.com/workos/workos-cli) to your Github Workflow

## Example usage

Include this Action as a step in your workflow:

```

uses: workos/cli-action@v1

```

## Configuration

You'll need to provide a version with the `Install CLI` step. 

Using the CLI requires a WorkOS API key. You can provide this key as an environment variable in your workflow file:

```yaml

name: Example action

on: [push]

jobs:

  my-job:

    runs-on: ubuntu-latest

    steps:

      - name: Install CLI

        uses: workos/cli-action@v1

        with:

          version: v0.2.0

      - name: Do something with the CLI

        run: workos --version

        env:

          WORKOS_ACTIVE_ENVIRONMENT: headless

          WORKOS_ENVIRONMENTS_HEADLESS_ENDPOINT: 

          WORKOS_ENVIRONMENTS_HEADLESS_API_KEY: ${{ secrets.WORKOS_ENVIRONMENTS_HEADLESS_API_KEY }}

```