Metadata-Version: 2.1
Name: nb-cli-plugin-littlepaimon
Version: 1.0.0rc2
Summary: Nonebot Cli plugin for LittlePaimon
Home-page: https://github.com/CMHopeSunshine/nb-cli-plugin-littlepaimon
License: AGPL
Keywords: nonebot2,nb-cli
Author: CMHopeSunshine
Author-email: 277073121@qq.com
Requires-Python: >=3.8,<4.0
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: nb-cli (>=1.0.2,<2.0.0)
Requires-Dist: py-cpuinfo (>=9.0.0,<10.0.0)
Requires-Dist: rich (>=13.3.1,<14.0.0)
Description-Content-Type: text/markdown

<!-- markdownlint-disable MD033 MD041 -->
<p align="center">
  <img src="https://cli.nonebot.dev/logo.png" width="200" height="200" alt="nonebot">
</p>

<div align="center">

# NB CLI Plugin For LittlePaimon

_✨ 为[小派蒙Bot](https://github.com/CMHopeSunshine/LittlePaimon)定制的 NoneBot2 CLI 插件 ✨_

<a href="./LICENSE">
    <img src="https://img.shields.io/github/license/CMHopeSunshine/nb-cli-plugin-littlepaimon.svg" alt="license">
</a>
<a href="https://pypi.python.org/pypi/nb-cli-plugin-littlepaimon">
    <img src="https://img.shields.io/pypi/v/nb-cli-plugin-littlepaimon.svg" alt="pypi">
</a>
<img src="https://img.shields.io/badge/python-3.8+-blue.svg" alt="python">


</div>

## 演示

[![asciicast](https://asciinema.org/a/kMBRbuX5lCEnk5lmXcU53ys5b.svg)](https://asciinema.org/a/kMBRbuX5lCEnk5lmXcU53ys5b)

## 安装

<details>
<summary>安装nb-cli</summary>

> 请确保你的Python版本为3.8+，且在环境变量中

<details>
<summary>通过 pipx 安装</summary>

```shell
pip install --user pipx
pipx ensurepath
pipx install nb-cli
```
</details>

<details>
<summary>通过 pip 安装</summary>

```shell
pip install nb-cli
```
</details>

</details>

---

<details>
<summary>安装本插件</summary>

<details>
<summary>通过 nb-cli 安装</summary>

```shell
nb self install nb-cli-plugin-littlepaimon
```

</details>

<details>
<summary>通过 pipx 安装</summary>

```shell
pipx inject nb-cli nb-cli-plugin-littlepaimon
```
</details>

<details>
<summary>通过 pip 安装</summary>

```shell
pip install nb-cli-plugin-littlepaimon
```
</details>

</details>

---

<details>
<summary>安装Git</summary>

~~能上Github的话，应该都会装Git吧)~~

</details>

## 使用

- `nb paimon` 交互式使用
  - `nb paimon create` 
    - 交互式指引安装[LittlePaimon](https://github.com/CMHopeSunshine/LittlePaimon)
    - 自动克隆源码、创建虚拟环境、安装依赖，下载并配置go-cqhttp
  - `nb paimon run` 启动小派蒙
    - 实际上和`nb run`一样，不过去掉了不常用的参数 
  - `nb paimon install` 安装依赖库到小派蒙环境中
  - `nb paimon res` 下载或更新小派蒙的资源
  - `nb paimon update` 更新小派蒙，和`git pull`一样
  - `nb paimon logo` 展示小派蒙的logo
- `nb paimon (xxx) --help` 查看帮助

## TODO

- [x] 更新资源
- [ ] 自动安装git
- [ ] 修改配置
- [ ] 安装小派蒙插件
- [ ] more

## 相关项目
- [nb-cli](https://github.com/nonebot/nb-cli)
- [LittlePaimon](https://github.com/CMHopeSunshine/LittlePaimon)
