Dashboardctl

Warning

This project is in early development. The builtin resources are not yet stable and can introduce breaking changes at any time. Pin your version, review the changelog before upgrading, and do not use this for production workloads until it reaches a stable release.

A commandline client to interact with Curseforge. For now it's mostly used to fetch mods defined within modpack manifests.

Install

You can download prebuilt binaries from the GitHub releases. If you prefer to use containers you could use our images published on GHCR. If you need further guidance how to install this take a look at our docs.

Prerequisites

We use mise to manage all required tools and their versions. Install it by following the official installation instructions, then run the following commands inside the repository to activate mise and install all tools defined in mise.toml:

mise trust
mise install

Build

Since all required commands ar part of our go-task taskfile the commands you got to execute are quite simple:

git clone https://github.com/cloudpunks/dashboardctl.git
cd dashboardctl

task build
./bin/dashboardctl -h

Development

To start developing on this project you have to execute only a few commands in multiple terminal tabs or windows:

task watch

After that you can simply execute the tool via bin/dashboardctl -h. Generally it supports hot reloading which means the binary gets automatically recompiled on code changes.

Security

If you find a security issue please contact info@cloudpunks.de first.

Contributing

Generally we are following conventional commits when we apply changes. That way we are able to generate proper changelogs for every release. Please use always pull requests to integrate new functionalities or to fix issues.

For the release process we are following semantic versioning which clearly indicates if a new version just resolves bugs, includes new features or even includes breaking changes.

After installing the tools via mise install as described above set up the pre-commit hooks so they run automatically on every commit:

prek install --hook-type pre-commit --hook-type commit-msg

prek is managed by mise and will be available after mise install.

If you have changed something on the source you should simply commit following the mentioned conventions:

git checkout -b feat/new-feature
git add --all
git commit -m 'feat: added awesome new feature'
git push --set-upstream origin feat/new-feature

After pushing your changes into the Git repository you should create a pull request on GitHub. If the pull request have been merged and everything built fine it will also create automatically a new release at least once a week.

Authors

• Thomas Boerger

License

Apache-2.0

Copyright

Copyright (c) 2026 cloudpunks GmbH <info@cloudpunks.de>