https://github.com/zachspar/setup-tool
GitHub action to setup any 3rd partly CLI tool.
https://github.com/zachspar/setup-tool
Last synced: 5 months ago
JSON representation
GitHub action to setup any 3rd partly CLI tool.
- Host: GitHub
- URL: https://github.com/zachspar/setup-tool
- Owner: zachspar
- License: mit
- Created: 2024-07-02T00:00:20.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-14T17:27:32.000Z (over 1 year ago)
- Last Synced: 2025-12-15T15:15:00.214Z (6 months ago)
- Language: TypeScript
- Homepage:
- Size: 384 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Setup Tool Action
> [!NOTE]
> This action is geared toward setting up simple CLI tools from a tarball URL.
A GitHub Action to setup _any_ tool.
## Usage
```yaml
- uses: zachspar/setup-tool@v0.1.0
with:
# Description: The name of the tool to setup.
# Required: false
# Default: 'tool'
name: 'tool-name'
# Description: The tarball URL to download the tool.
# Required: true
tarball-url: 'https://example.com/tool.tar.gz'
```
## Example
See the example below that sets up a tool called
[`yq`](https://github.com/mikefarah/yq).
```yaml
steps:
- name: Checkout
id: checkout
uses: actions/checkout@v4
- name: Setup Tool
id: setup-tool
uses: zachspar/setup-tool@v0.1.0
with:
name: 'yq'
tarball-url: 'https://github.com/mikefarah/yq/releases/download/v4.44.2/yq_linux_amd64.tar.gz'
- name: Print Tool Path
run: echo "${{ steps.setup-tool.outputs.tool-path }}"
```