hx Command Line
This GitHub Action downloads, installs, and authenticates the Hyphen command line tool (hx) using the provided API Key. Once the action is run, the hx
CLI will be available in the path of the action container and can be used in subsequent steps.
Many other Hyphen actions require this action to be run first, as they rely on the
hx
CLI being available in the container's path.
Prerequisites
Before getting started, ensure you have:
- Signed up for a Hyphen account and have access to an organization
- You have access to a Hyphen API key for the organization
Parameters
apiKey
(required): The API key used to authenticate the command line tool.version
(optional): The specific version of the command line to install. If not set, the latest version will be installed.
Example Usage
steps:
- name: Checkout
id: checkout
uses: actions/checkout@v4
- name: Setup Hyphen CLI
id: setup-hx
uses: Hyphen/setup-hx-action@v1
with:
apiKey: ${{ secrets.HYPHEN_API_KEY }}
- name: List Projects
id: list-projects
run: hx project list
Specifying a Version
steps:
- name: Setup Hyphen CLI with Specific Version
uses: Hyphen/setup-hx-action@v1
with:
apiKey: ${{ secrets.HYPHEN_API_KEY }}
version: "1.2.3" # specify the desired version here
Updated 19 days ago
Whatβs Next