https://github.com/ghostmanager/ghostwriter_cli
Golang CLI binary used for installing and managing Ghostwriter
https://github.com/ghostmanager/ghostwriter_cli
cli command-line command-line-tool docker docker-compose go golang
Last synced: 3 months ago
JSON representation
Golang CLI binary used for installing and managing Ghostwriter
- Host: GitHub
- URL: https://github.com/ghostmanager/ghostwriter_cli
- Owner: GhostManager
- License: bsd-3-clause
- Created: 2022-05-10T08:17:44.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-07-21T21:36:49.000Z (3 months ago)
- Last Synced: 2025-07-21T23:23:18.927Z (3 months ago)
- Topics: cli, command-line, command-line-tool, docker, docker-compose, go, golang
- Language: Go
- Homepage:
- Size: 329 KB
- Stars: 19
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Ghostwriter_CLI
[](.) [](.)
[](.)
Golang code for the `ghostwriter-cli` binary in [Ghostwriter](https://github.com/GhostManager/Ghostwriter). This binary provides control for various aspects of Ghostwriter's configuration.
## Usage
Execute `./ghostwriter-cli help` for usage information (see below). More information about Ghostwriter and how to manage it with `ghostwriter-cli` can be found on the [Ghostwriter Wiki](https://ghostwriter.wiki/).
```plaintext
Ghostwriter CLI is a command line interface for managing the Ghostwriter
application and associated containers and services. Commands are grouped by their use.
Usage:
ghostwriter-cli [command]
Available Commands:
backup Creates a backup of the PostgreSQL database
completion Generate the autocompletion script for the specified shell
config Display or adjust the configuration
containers Manage Ghostwriter containers with subcommands
down Shortcut for `containers down`
gencert Create a new SSL/TLS certificate and DH param file for the Nginx web server
healthcheck Check the health of Ghostwriter's services
help Help about any command
install Builds containers and performs first-time setup of Ghostwriter
logs Fetch logs for Ghostwriter services
pg-upgrade Upgrades the PostgreSQL database
restore Restores the specified PostgreSQL database backup
running Print a list of running Ghostwriter services
tagcleanup Run Django's tag cleanup commands to deduplicate tags and remove orphaned tags
test Runs Ghostwriter's unit tests in the development environment
uninstall Remove all Ghostwriter containers, images, and volume data
up Shortcut for `containers up`
update Displays version information for Ghostwriter
version Displays Ghostwriter CLI's version information
Flags:
--dev Target the development environment for "install" and "containers" commands.
-h, --help help for ghostwriter-cli
Use "ghostwriter-cli [command] --help" for more information about a command.
```
## Compilation
The binaries distributed with Ghostwriter and attached to releases are compiled with the following command to set version and build date information:
```bash
go build -ldflags="-s -w -X 'github.com/GhostManager/Ghostwriter_CLI/cmd/config.Version=`git describe --tags --abbrev=0`' -X 'github.com/GhostManager/Ghostwriter_CLI/cmd/config.BuildDate=`date -u '+%d %b %Y'`'" -o ghostwriter-cli main.go
```
The version for rolling releases is set to `rolling`.
Builds pass through `upx` with `upx --brute ghostwriter-cli`. This is simply so that the standard ~8.5MB Golang file is compressed down to a ~2.5MB file for easier inclusion with the Ghostwriter repo.
All releases include the MD5 hash of the packed binary so you can verify the downloaded binary matches the release. Compile and pack the code with the above commands (or use the pre-compiled binary from a release or Ghostwriter) and then calculate the hash with `md5sum` for comparison. Note that hashes will be different if your command sets different version and build date information.