https://github.com/gopad/gopad-cli
Commandline client for Gopad
https://github.com/gopad/gopad-cli
cli client etherpad go golang gopad
Last synced: 12 months ago
JSON representation
Commandline client for Gopad
- Host: GitHub
- URL: https://github.com/gopad/gopad-cli
- Owner: gopad
- License: apache-2.0
- Created: 2018-01-02T23:14:05.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2025-06-02T11:15:26.000Z (12 months ago)
- Last Synced: 2025-06-02T19:19:41.930Z (12 months ago)
- Topics: cli, client, etherpad, go, golang, gopad
- Language: Go
- Homepage: https://gopad.eu
- Size: 2.99 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Gopad: CLI client
[](https://github.com/gopad/gopad-cli/actions/workflows/general.yml) [](https://matrix.to/#/#gopad:matrix.org) [](https://app.codacy.com/gh/gopad/gopad-cli/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) [](https://pkg.go.dev/github.com/gopad/gopad-cli) [](https://github.com/gopad/gopad-cli)
> [!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][api] server.
## 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 [Baltorepo][baltorepo]. If you prefer
to use containers you could use our images published on [GHCR][ghcr],
[Docker Hub][dockerhub] or [Quay][quay]. You are a Mac user? Just take a look
at our [homebrew formula][homebrew]. If you need further guidance how to
install this take a look at our [documentation][docs].
## 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/gopad/gopad-cli.git
cd gopad-cli
task generate build
./bin/gopad-cli -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:
```console
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](mailto:gopad@webhippie.de) first.
## Contributing
Fork -> Patch -> Push -> Pull Request
## Authors
- [Thomas Boerger](https://github.com/tboerger)
## License
Apache-2.0
## Copyright
```console
Copyright (c) 2018 Thomas Boerger
```
[api]: https://github.com/gopad/gopad-cli
[releases]: https://github.com/gopad/gopad-cli/releases
[downloads]: https://dl.gopad.eu
[homebrew]: https://github.com/gopad/homebrew-gopad
[ghcr]: https://github.com/orgs/gopad/packages
[dockerhub]: https://hub.docker.com/r/gopad/gopad-cli/tags/
[quay]: https://quay.io/repository/gopad/gopad-cli?tab=tags
[docs]: https://gopad.eu/
[nix]: https://nixos.org/
[golang]: http://golang.org/doc/install.html
[gotask]: https://taskfile.dev/installation/
[direnv]: https://direnv.net/