zmkfirmware / zmkfirmware/zmk-cli
`zmk download` as an alias to `gh run download`
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 20
- Forks
- 8
- PR merge metrics
- No merged PRs in 30d
Description
I'm new to ZMK and I think that there's a better way to fetch the artifact (firmware) of a GitHub action.
Instead of running zmk download, which only slightly eases the process, I have been running gh run download which fetches the latest artifact.
In more detail, here's my workflow:
- push changes;
- check that CI has finished successfully via
gh run list -L 5; - ensure that a folder named firmware doesn't exist and run
gh run download; - flash.
Note that gh run download may take a --repo flag and an id of the action as an argument. This ensures that a deterministic call is achievable.
What do you think?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the existing zmk download CLI entry point and checking how it currently fetches firmware artifacts. Compare its behavior with gh run download, including the optional --repo flag and workflow run ID described in the issue. Done means the proposed alias behavior is implemented and verified against the documented download workflow.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github, python
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100