Skip to content

gofr-dev/gofr-cli

Repository files navigation

GoFr Command Line Interface 🚀

logo

Apache 2.0 License discord

⚙️ What is GoFr CLI?

GoFr CLI is the command line tool for initializing projects and performing tasks in accordance with GoFr framework. Users can use this CLI from initializing a simple hello world program using GoFr to writing migrations for your databases.


💡 Key Features

  1. init - Initializes a new GoFr project with a basic "Hello World!" program.
  2. migrate create - Creates boilerplate code for database migrations to modify your schema.
  3. wrap grpc - Creates gRPC handlers with GoFr context based on proto files.
  4. version - Checks the current version of the GoFr CLI tool.

🚀 Getting Started

Prerequisites

  • GoFr CLI requires Go version 1.22 or above.

Installation

To get started with GoFr CLI, use the below commands

  go install gofr.dev/cli/gofr@latest

To check the installation:

  gofr version

🔒 Secure Cloning

To securely clone the GoFr CLI repository, you can use HTTPS or SSH:

Cloning with HTTPS

  https://github.com/gofr-dev/gofr-cli.git

Cloning with SSH

  git@github.com:gofr-dev/gofr-cli.git

🤝 Contributing

Contributions are welcome! Please see the CONTRIBUTING.md file for guidelines.


🎁 Get a GoFr T-Shirt & Stickers!

If your PR is merged, or if you contribute by writing articles or promoting GoFr CLI, we invite you to fill out this form to claim your GoFr merchandise as a token of our appreciation!

Partners

JetBrains logo