README
¶
Gopad: CLI client
[!CAUTION] This project is in active development and does not provide any stable release yet, you can expect breaking changes until our first real release!
Within this repository we are building the command-line client to interact with the Gopad API server.
Install
You can download prebuilt binaries from the GitHub releases or from our download site. Besides that we also prepared repositories for DEB and RPM packages which can be found at Cloudsmith. If you prefer to use containers you could use our images published on GHCR, Docker Hub or Quay. You are a Mac user? Just take a look at our homebrew formula. If you need further guidance how to install this take a look at our documentation.
Package repository hosting is graciously provided by 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 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. Beside that we are using go-task to define all commands to build this project.
git clone https://github.com/gopad/gopad-cli.git
cd gopad-cli
task generate build
./bin/gopad-cli -h
If you got Nix and Direnv configured you can simply execute the following commands to get al dependencies including go-task and the required runtimes installed:
cat << EOF > .envrc
use flake . --impure --extra-experimental-features nix-command
EOF
direnv allow
Security
If you find a security issue please contact gopad@webhippie.de first.
Contributing
Fork -> Patch -> Push -> Pull Request
Authors
License
Apache-2.0
Copyright
Copyright (c) 2018 Thomas Boerger <thomas@webhippie.de>
Directories