https://github.com/unfunco/setup-gum
Install Gum (a tool for glamorous shell scripts) in GitHub Actions.
https://github.com/unfunco/setup-gum
charm charmbracelet github-actions gum typescript
Last synced: 28 days ago
JSON representation
Install Gum (a tool for glamorous shell scripts) in GitHub Actions.
- Host: GitHub
- URL: https://github.com/unfunco/setup-gum
- Owner: unfunco
- License: mit
- Created: 2025-08-09T23:51:43.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-08-10T13:33:22.000Z (10 months ago)
- Last Synced: 2025-08-10T15:33:02.020Z (10 months ago)
- Topics: charm, charmbracelet, github-actions, gum, typescript
- Language: TypeScript
- Homepage: https://github.com/charmbracelet/gum
- Size: 2.58 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Gum for GitHub Actions
[](https://opensource.org/licenses/MIT)
[Gum] is a tool for glamorous shell scripts, made by [Charm]. This GitHub Action
installs Gum on your GitHub Actions runner, allowing you to use it in your
workflows. It supports Ubuntu and macOS runners.
> [!NOTE]
> I am not affiliated with Charm or the Gum project.
## 🔧 Getting started
### Usage instructions
The following example demonstrates how to use the action in a GitHub Actions job
to install a specific version of Gum and verify the installation by displaying
the version number.
```yaml
- name: Set up Gum
uses: unfunco/setup-gum@main
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Verify installation
run: |
gum style \
--align center \
--bold \
--border double \
--margin "1 2" \
--padding "2 4" \
--width 50 \
"$(gum --version) installed successfully!"
```
### Development and testing
#### Requirements
- [Node.js] 20.x and [npm] 10+
Clone the repository, change into the `setup-gum` directory, install the
development dependencies, and create an `.env` file by copying the example
included in the root of the repository, once completed you have everything you
need to develop and test the action locally.
```bash
git clone git@github.com:unfunco/setup-gum.git
cd setup-tools
npm install
cp .env.example .env
```
Make changes and run the unit tests to ensure everything is working as expected.
There are additional commands available to format the code and build the action
for production use, these will be run automatically when you commit changes to
the repository.
```bash
npm run test
```
You can also run the action locally, the following command will run the action
with the environment variables defined in your `.env` file. Running it for the
first time will download the tools specified in your `.env` file, subsequent
runs will detect the locally cached versions.
```bash
npm run locally
```
## License
© 2025 [Daniel Morris]\
Made available under the terms of the [MIT License].
[charm]: https://charm.land
[daniel morris]: https://unfun.co
[gum]: https://github.com/charmbracelet/gum
[node.js]: https://nodejs.org
[npm]: https://www.npmjs.com
[mit license]: LICENSE.md