https://github.com/stack-spot/stk-cli-action

GitHub action to install StackSpot CLI :octocat:
https://github.com/stack-spot/stk-cli-action

all-os-supported cli code github-actions maintain stacks-admin stackspot

Last synced: 4 months ago
JSON representation

GitHub action to install StackSpot CLI :octocat:

• Host: GitHub
• URL: https://github.com/stack-spot/stk-cli-action
• Owner: stack-spot
• License: apache-2.0
• Created: 2022-11-16T17:10:32.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2025-02-11T20:19:09.000Z (11 months ago)
• Last Synced: 2025-04-01T13:35:22.273Z (10 months ago)
• Topics: all-os-supported, cli, code, github-actions, maintain, stacks-admin, stackspot
• Homepage: https://www.stackspot.com
• Size: 33.2 KB
• Stars: 6
• Watchers: 4
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# stk-cli-action

[![Action test Ubuntu](https://github.com/stack-spot/stk-cli-action/actions/workflows/action-test-ubuntu.yml/badge.svg)](https://github.com/stack-spot/stk-cli-action/actions/workflows/action-test-ubuntu.yml) [![Action test MacOS](https://github.com/stack-spot/stk-cli-action/actions/workflows/action-test-macos.yml/badge.svg)](https://github.com/stack-spot/stk-cli-action/actions/workflows/action-test-macos.yml) [![Action test Windows](https://github.com/stack-spot/stk-cli-action/actions/workflows/action-test-windows.yml/badge.svg)](https://github.com/stack-spot/stk-cli-action/actions/workflows/action-test-windows.yml)

GitHub action to install StackSpot CLI :octocat:

_**Note**: This action is supported on all runners operating systems (`ubuntu`, `macos`, `windows`)_

## 📚 Usage

### Requirements

To get the account keys (`CLIENT_ID`, `CLIENT_KEY` and `REALM`), please login using a **ADMIN** user on the [StackSpot Portal](https://stackspot.com), and generate new keys at [https://stackspot.com/en/settings/access-token](https://stackspot.com/en/settings/access-token).

### Use Case

```yaml

    steps:

      - uses: stack-spot/stk-cli-action@v1.1

        with:

          client_id: ${{ secrets.CLIENT_ID }}

          client_key: ${{ secrets.CLIENT_KEY }}

          realm: ${{ secrets.REALM }}

      - run: stk import stack 

```

## License

[Apache License 2.0](https://github.com/stack-spot/stk-cli-action/blob/main/LICENSE)