An open API service indexing awesome lists of open source software.

https://github.com/webhippie/cursecli

Commandline client for Curseforge
https://github.com/webhippie/cursecli

cli client curseforge manifest

Last synced: 4 months ago
JSON representation

Commandline client for Curseforge

Awesome Lists containing this project

README

          

# Cursecli

[![General Workflow](https://github.com/webhippie/cursecli/actions/workflows/general.yml/badge.svg)](https://github.com/webhippie/cursecli/actions/workflows/general.yml) [![Join the Matrix chat at https://matrix.to/#/#webhippie:matrix.org](https://img.shields.io/badge/matrix-%23webhippie-7bc9a4.svg)](https://matrix.to/#/#webhippie:matrix.org) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/47d8475af4a64c49857835dd68781565)](https://app.codacy.com/gh/webhippie/cursecli/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) [![Go Reference](https://pkg.go.dev/badge/github.com/webhippie/cursecli.svg)](https://pkg.go.dev/github.com/webhippie/cursecli) [![Go Report Card](https://goreportcard.com/badge/github.com/webhippie/cursecli)](https://goreportcard.com/report/github.com/webhippie/cursecli) [![GitHub Repo](https://img.shields.io/badge/github-repo-yellowgreen)](https://github.com/webhippie/cursecli) [![Hosted By: Cloudsmith](https://img.shields.io/badge/OSS%20hosting%20by-cloudsmith-blue?logo=cloudsmith&style=flat-square)](https://cloudsmith.com)

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][releases] or from
our [download site][downloads]. Besides that we also prepared repositories for
DEB and RPM packages which can be found at [Cloudsmith][pkgrepo]. If you prefer
to use containers you could use our images published on [GHCR][ghcr],
[Docker Hub][dockerhub] or [Quay][quay]. If you need further guidance how to
install this take a look at our [documentation][docs].

Package repository hosting is graciously provided by [Cloudsmith][cloudsmith].
Cloudsmith is the only fully hosted, cloud-native, universal package management
solution, that enables your organization to create, store and share packages in
any format, to any place, with total confidence.

## Build

If you are not familiar with [Nix][nix] it is up to you to have a working
environment for Go (>= 1.24.0) as the setup won't we covered within this guide.
Please follow the official install instructions for [Go][golang]. Beside that we
are using [go-task][gotask] to define all commands to build this project.

```console
git clone https://github.com/webhippie/cursecli.git
cd cursecli

task build
./bin/cursecli -h
```

If you got [Nix][nix] and [Direnv][direnv] configured you can simply execute
the following commands to get al dependencies including [go-task][gotask] and
the required runtimes installed. You are also able to directly use the process
manager of [devenv][devenv]:

```console
cat << EOF > .envrc
use flake . --impure --extra-experimental-features nix-command
EOF

direnv allow
```

## Development

To start developing on this project you have to execute only one command to
build a binary matching your platform:

```console
task build
```

After that you can simply execute the tool via `bin/cursecli -h`.

## Security

If you find a security issue please contact
[thomas@webhippie.de](mailto:thomas@webhippie.de) first.

## Contributing

Fork -> Patch -> Push -> Pull Request

## Authors

- [Thomas Boerger](https://github.com/tboerger)

## License

Apache-2.0

## Copyright

```console
Copyright (c) 2022 Thomas Boerger
```

[releases]: https://github.com/webhippie/cursecli/releases
[downloads]: https://dl.webhippie.de/#cursecli/
[ghcr]: https://github.com/webhippie/cursecli/pkgs/container/cursecli
[dockerhub]: https://hub.docker.com/r/webhippie/cursecli/tags/
[quay]: https://quay.io/repository/webhippie/cursecli?tab=tags
[docs]: https://webhippie.github.io/cursecli/#getting-started
[nix]: https://nixos.org/
[golang]: http://golang.org/doc/install.html
[gotask]: https://taskfile.dev/installation/
[direnv]: https://direnv.net/
[devenv]: https://devenv.sh/
[pkgrepo]: https://cloudsmith.io/~webhippie/repos/general/groups/
[cloudsmith]: https://cloudsmith.com/