Skip to content

Latest commit

 

History

History
51 lines (33 loc) · 1.31 KB

README.md

File metadata and controls

51 lines (33 loc) · 1.31 KB

gothctl

gothctl is a CLI control system designed for managing the goth microservice. It provides tools to start the server and manage users directly from the command line.

Built With

  • Cobra - A Commander for modern Go CLI interactions
  • Viper - Go configuration with fangs

Installation

Please refer to INSTALLATION.md for detailed installation and building instructions.

Configuration

gothctl looks for a configuration file named .gothctl.yaml in your home directory or the current working directory. You can also use a .env file for environment variables.

Example gothctl.sample.yaml

(rename it to gothctl.yaml)

server:
  port: "8000"
database:
  uri: "mongodb://localhost:27017"

Environment Variables

Environment variables are prefixed with GOTH_. For example:

  • GOTH_SERVER_PORT=8080
  • GOTH_DATABASE_URI=mongodb://localhost:27017

Usage

For development, you can run the commands directly using go run:

Start the Server

go run main.go serve

Create a User

go run main.go user create

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.