Harvey CLI 使用教程

1. 项目介绍

Harvey 是一个命令行工具，旨在帮助开源项目管理者轻松管理项目的开源许可证。它允许用户通过命令行界面选择和添加合适的许可证到他们的项目中，避免了传统手动复制粘贴许可证的繁琐过程。本项目基于 Python 开发，支持多种操作系统，如 macOS、Linux 和 Windows。

2. 项目快速启动

在开始使用 Harvey 前，请确保您的环境中已经安装了 Python。以下是快速启动 Harvey 的步骤：

安装

方法一：使用 Pip

pip install harvey

方法二：从源代码安装

git clone [e-mail]:architv/harvey.git
cd harvey/
python setup.py install

注意： Windows 用户可能需要安装 ansicon 以使 colorama 正确工作。

使用

获取许可证摘要

harvey gpl-2.0 --tldr

为项目添加许可证

harvey mit > LICENSE

上述命令将创建一个 MIT 许可证，并将其内容输出到标准输出。如果你想要将许可证保存到文件中，可以直接重定向输出到文件：

harvey --export mit > LICENSE

列出所有支持的许可证

harvey ls

查看帮助信息

harvey --help

3. 应用案例和最佳实践

使用 Harvey，您可以快速地为新项目添加合适的许可证，确保项目合规。以下是一些应用案例和最佳实践：

• 在项目初始化阶段，使用 Harvey 选择和添加许可证，确保从项目开始就有明确的许可协议。
• 在项目维护过程中，如果需要更换许可证，使用 Harvey 可以方便地进行更换。
• 当您不确定选择哪种许可证时，Harvey 提供的许可证摘要可以帮助您做出决定。

4. 典型生态项目

Harvey 作为一款开源许可证管理工具，可以广泛应用于各种开源项目中。以下是一些可能的应用场景：

• 个人项目： 对于个人开发者来说，Harvey 可以帮助快速设置项目许可，保护代码的同时简化流程。
• 团队协作项目： 在团队开发中，使用统一的许可证管理工具可以帮助维护项目的一致性和合规性。
• 企业开源项目： 企业在开源项目中使用 Harvey，可以确保所有开源组件都符合企业的开源策略和法律法规要求。