article
README
🚀 项目中心
项目中心是一款集成化开发环境工具,它整合了代码仓库初始化、版本控制、文件快照、分支管理及知识库等功能,能有效提升软件项目的管理效率。
🚀 快速开始
项目中心功能丰富,可通过简单安装后快速投入使用,为项目管理带来便利。
✨ 主要特性
- 功能集成:整合代码仓库初始化、版本控制操作、文件快照、分支管理以及知识库等功能模块,提供一站式项目管理体验。
- 操作便捷:提供多种操作命令,方便用户进行本地仓库初始化、提交管理、分支管理等操作。
- 数据记录:在每次提交时自动捕获文件的元数据信息,还支持历史版本对比,便于追溯代码变更。
- 知识管理:具备知识库管理功能,支持创建笔记和按标签、类别或内容关键字进行检索。
📦 安装指南
方式一:使用npm安装
使用以下命令进行安装:
npm install project-hub --save-dev
方式二:手动下载
访问项目官网下载对应平台的压缩包,并解压到指定目录。
💻 使用示例
基础用法
初始化本地仓库
project-hub init-local-repository --projectId=my-project
创建提交
project-hub create-commit --projectId=my-project --message="feat: 添加新特性" --author=JohnDoe
高级用法
本地仓库初始化
通过init_local_repository命令,可在指定项目目录下初始化新的Git仓库:
project-hub init-local-repository --projectId=project-123
提交管理
支持创建、查看和撤销提交操作,示例如下:
- 创建新提交:
create_commit - 恢复到历史提交:
restore_to_local_commit - 克隆仓库至新位置:
restore_local_branch_to_new_location
分支管理
提供完整的分支生命周期管理功能,包括创建、切换、删除和同步等操作。
📚 详细文档
知识库管理
- 创建笔记:记录开发过程中的重要决策和经验教训。
- 搜索功能:支持按标签、类别或内容关键字进行检索。
文件快照
- 在每次提交时自动捕获文件的元数据信息,包括大小、创建时间和修改时间等。
- 提供历史版本对比功能,便于追溯代码变更。
开发指南
- 为项目功能模块添加新特性。
- 执行单元测试:
npm test
- 构建发布包:
npm run build
最近改进
本地Git功能(2024年3月)
- 实现了完整的本地Git操作,包括提交、分支和文件快照。
- 增加了恢复功能以回溯到之前的状态。
- 支持将指定分支克隆至新位置。
- 文件快照增加元数据记录。
项目管理改进(2024年2月)
- 新增
clone_repository工具,支持从GitHub仓库克隆代码库到指定目录。 - 实现
scan_project_files功能,用于扫描和记录项目文件结构。 - 优化项目搜索功能,实现不区分大小写的模糊匹配。
- 增强文件追踪能力,提升元数据记录维度。
贡献指南
- Fork本仓库。
- 创建功能分支。
- 提交修改内容。
- 推送到分支。
- 提交Pull Request。
📄 许可证
本项目遵循MIT协议。
Scan to join WeChat group