|
1 | | -# figo |
| 1 | +<div align="center"> |
| 2 | +<picture> |
| 3 | + <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/itpey/figo/main/static/images/figo_icon_dark.png" width="250" height="100"> |
| 4 | + <img alt="figo" src="https://raw.githubusercontent.com/itpey/figo/main/static/images/figo_icon-light.png" width="250" height="100" > |
| 5 | +</picture> |
| 6 | +</div> |
| 7 | + |
| 8 | +<p align="center"> |
| 9 | +Figo is a command-line tool for rapidly scaffolding new Go projects based on customizable templates. It provides various commands to create, manage, and work with project templates efficiently. |
| 10 | +</p> |
| 11 | + |
| 12 | +<p align="center"> |
| 13 | + <a href="https://pkg.go.dev/github.com/itpey/keycontrol"> |
| 14 | + <img src="https://pkg.go.dev/badge/github.com/itpey/figo.svg" alt="Go Reference"> |
| 15 | + </a> |
| 16 | + <a href="https://github.com/itpey/figo/blob/main/LICENSE"> |
| 17 | + <img src="https://img.shields.io/github/license/itpey/figo" alt="license"> |
| 18 | + </a> |
| 19 | +</p> |
| 20 | + |
| 21 | +# Features |
| 22 | + |
| 23 | +- **Project Creation**: Create new Go projects from predefined templates. |
| 24 | +- **Template Management**: |
| 25 | + - List available project templates. |
| 26 | + - Add templates from Git repositories. |
| 27 | + - Delete specific or all project templates. |
| 28 | +- **Environment Check**: Verify system environment for required tools (Git and Go). |
| 29 | + |
| 30 | +# Installation |
| 31 | + |
| 32 | +Make sure you have Go installed and configured on your system. Use go install to install Figo: |
| 33 | + |
| 34 | +```bash |
| 35 | +go install github.com/itpey/figo@latest |
| 36 | +``` |
| 37 | + |
| 38 | +Ensure that your `GOBIN` directory is in your `PATH` for the installed binary to be accessible globally. |
| 39 | + |
| 40 | +# Usage |
| 41 | + |
| 42 | +## Checking System Environment |
| 43 | + |
| 44 | +To check the system environment for required tools (Git and Go): |
| 45 | + |
| 46 | +```bash |
| 47 | +figo doctor |
| 48 | +``` |
| 49 | + |
| 50 | +## Creating a New Project |
| 51 | + |
| 52 | +To create a new Go project with Figo: |
| 53 | + |
| 54 | +```bash |
| 55 | +figo |
| 56 | +``` |
| 57 | + |
| 58 | +This will prompt you to enter the project name and select a template interactively. |
| 59 | + |
| 60 | +## Advanced Usage |
| 61 | + |
| 62 | +To view detailed usage instructions and available commands: |
| 63 | + |
| 64 | +```bash |
| 65 | +figo -h |
| 66 | +``` |
| 67 | + |
| 68 | +This will display comprehensive information about using Figo, including commands, options, and examples. |
| 69 | + |
| 70 | +# Feedback and Contributions |
| 71 | + |
| 72 | +If you encounter any issues or have suggestions for improvement, please [open an issue](https://github.com/itpey/figo/issues) on GitHub. |
| 73 | + |
| 74 | +We welcome contributions! Fork the repository, make your changes, and submit a pull request. |
| 75 | + |
| 76 | +# License |
| 77 | + |
| 78 | +Figo is open-source software released under the Apache License, Version 2.0. You can find a copy of the license in the [LICENSE](https://github.com/itpey/figo/blob/main/LICENSE) file. |
| 79 | + |
| 80 | +# Author |
| 81 | + |
| 82 | +Figo was created by [itpey](https://github.com/itpey). |
0 commit comments