Skip to content

Commit

Permalink
📝 docs: Update file README of lobe-commit (#103)
Browse files Browse the repository at this point in the history
  • Loading branch information
RubuJam authored Jul 8, 2024
1 parent 099a8d4 commit 2ebe92d
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 14 deletions.
30 changes: 23 additions & 7 deletions packages/lobe-commit/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,21 @@ To configure Lobe Commit, run the following command:
$ lobe-commit --option # or use short flag -o
```

### Running

To make a commit, run one of the following commands:

```shell
$ lobe-commit --hook # Run either of the two commands
$ git commit
```

<div align="right">

[![][back-to-top]](#readme-top)

</div>

- To use AI auto-generation, you need to fill in your [OpenAI token](<(https://platform.openai.com/account/api-keys)>) in the settings.
- To automatically pull private issues, you need to fill in your [GitHub token](https://github.com/settings/tokens) with repo permissions in the settings.

Expand All @@ -170,13 +185,14 @@ $ lobe-commit --option # or use short flag -o
Lobe Commit supports the following options:

```shell
--commit -c Interactively commit using the prompts
--option -o Setup lobe-commit preferences
--help -h Print basic options
--init -i Initialize lobe-commit as a commit hook
--remove -r Remove a previously initialized commit hook
--list -l List all the available commit type
--version -v Print lobe-commit installed version
--hook Commit interactively using prompts
-a, --ai Generate prompts by ChatGPT
-o, --option Setup lobe-commit preferences
-i, --init Initialize lobe-commit as a commit hook
-r, --remove Remove a previously initialized commit hook
-l, --list List all commit types supported
-V, --version Print lobe-commit installed version
-h, --help Print basic options
```

<div align="right">
Expand Down
30 changes: 23 additions & 7 deletions packages/lobe-commit/README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,21 @@ $ lobe-commit --remove # 或使用短标志 -r
$ lobe-commit --option # 或使用短标志 -o
```

### 运行

要进行 commit 提交,请运行以下命令:

```shell
$ lobe-commit --hook # 两个命令任选其一
$ git commit
```

<div align="right">

[![][back-to-top]](#readme-top)

</div>

- 要使用 AI 自动生成,需要在设置中填写 [OpenAI 令牌](https://platform.openai.com/account/api-keys)
- 要自动拉取私人仓库 issues,需要在设置中填写具有 repo 权限的 [GitHub 令牌](https://github.com/settings/tokens)

Expand All @@ -170,13 +185,14 @@ $ lobe-commit --option # 或使用短标志 -o
Lobe Commit 支持以下选项:

```shell
--commit -c 使用提示交互式提交
--option -o 设置lobe-commit首选项
--help -h 打印基本选项
--init -i 将lobe-commit初始化为提交钩子
--remove -r 删除先前初始化的提交钩子
--list -l 列出所有可用的提交类型
--version -v 打印lobe-commit安装版本
--hook 使用基于提示的交互方式进行 commit 提交
-a, --ai 由 Ai 生成提示
-o, --option 设置 lobe-commit 首选项
-i, --init 将 lobe-commit 初始化为提交钩子
-r, --remove 移除先前初始化的提交钩子
-l, --list 列出所有支持的提交类型
-V, --version 打印 lobe-commit 的安装版本
-h, --help 打印基本选项
```

<div align="right">
Expand Down

0 comments on commit 2ebe92d

Please sign in to comment.