https://github.com/gofr-dev/gofr-cli
Gofr command line utility
https://github.com/gofr-dev/gofr-cli
Last synced: 8 months ago
JSON representation
Gofr command line utility
- Host: GitHub
- URL: https://github.com/gofr-dev/gofr-cli
- Owner: gofr-dev
- Created: 2024-04-16T11:47:52.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-09T11:53:33.000Z (over 1 year ago)
- Last Synced: 2024-09-09T14:08:15.048Z (over 1 year ago)
- Language: Go
- Size: 49.8 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
GoFr Command Line Interface 🚀
## ⚙️ **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](https://go.dev/)** version **[1.22](https://go.dev/doc/devel/release#go1.22.0)** or above.
### **Installation**
To get started with GoFr CLI, use the below commands
```bash
go install gofr.dev/cli/gofr@latest
```
To check the installation:
```bash
gofr version
```
---
## 🔒 **Secure Cloning**
To securely clone the GoFr CLI repository, you can use HTTPS or SSH:
### Cloning with HTTPS
```bash
https://github.com/gofr-dev/gofr-cli.git
```
### Cloning with SSH
```bash
git@github.com:gofr-dev/gofr-cli.git
```
---
## 🤝 **Contributing**
Contributions are welcome! Please see the [CONTRIBUTING.md](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](https://forms.gle/R1Yz7ZzY3U5WWTgy5) to claim your GoFr merchandise as a token of our appreciation!
### Partners
