# vg-cli

**Repository Path**: lyw_vg/vg-cli

## Basic Information

- **Project Name**: vg-cli
- **Description**: Vg个人项目的脚手架工具，为提高个人工作和学习时创建项目的效率。
- **Primary Language**: Unknown
- **License**: Zlib
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-07-28
- **Last Updated**: 2025-02-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# VG-CLI 🚀

## 项目简介

VG-CLI 是一个简单的命令行工具，旨在为日常工作提供快速便捷的命令。它支持多种实用功能，如快速创建项目、一键集成 Jeecg 代码等。👩‍💻👨‍💻

## 技术栈

- Node.js 🌐

## 安装

要安装 VG-CLI，请确保您的系统已安装 Node.js(v20.15.0 及以上) 和 npm。然后运行以下命令：

```sh
npm install -g lyw-vg-cli 📦
```

## 使用方法

安装完成后，您可以全局执行 `vg` 命令。以下是一些常用命令：

### 快速创建项目 📁

```sh
vg create <project-name>
```

这将创建一个新的项目目录，并初始化所需的文件和结构。

### 一键集成 Jeecg 代码 🔧

```sh
vg jeecg
```

这将自动集成 Jeecg 代码到您的项目中。

## 配置文件 📝

VG-CLI 使用一个配置文件 `setting.json` 来管理jeecg生成代码的源目录路径。

## 测试 🧪

目前，只经过了基本自测保证了项目的基本使用，后续添加渐进式的添加单元测试。

## 贡献指南 🤝

我们欢迎任何形式的贡献！如果您发现任何问题或有改进建议，请按照以下步骤操作：

1. **Fork 仓库**：点击 GitHub 仓库右上角的 "Fork" 按钮。
2. **克隆仓库**：将 Fork 后的仓库克隆到本地。
3. **创建分支**：在本地仓库中创建一个新的分支。
4. **提交更改**：在新分支中进行您的更改。
5. **推送更改**：将更改推送到您的 GitHub 仓库。
6. **提交 Pull Request**：在 GitHub 上提交 Pull Request。

## 许可证 📜

本项目采用 MIT 许可证，详情请参见 [LICENSE](LICENSE) 文件。

## 联系方式 📧

如果您有任何问题或建议，请通过以下方式联系我们：

- **GitHub Issues**：[https://gitee.com/lyw_vg/vg-cli/issues](https://gitee.com/lyw_vg/vg-cli/issues)
- **Email**：152306560398@163.com