Skip to content
This repository was archived by the owner on Dec 12, 2025. It is now read-only.

Commit 6214370

Browse files
committed
docs: add name api
1 parent 495245f commit 6214370

2 files changed

Lines changed: 2 additions & 0 deletions

File tree

docs/getting-started.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ Install clerc, and create a file named `cli.mjs`:
4040

4141
```ts
4242
Clerc.create() // Create a new Clerc instance
43+
.name("foo") // Optional, CLI name, used to generate help text
4344
.scriptName("foo") // CLI script name
4445
.description("A foo CLI") // CLI description
4546
.version("0.0.0") // CLI version

docs/zh/getting-started.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ $ pnpm add clerc
4040

4141
```ts
4242
Clerc.create() // 创建一个新的 Clerc 实例
43+
.name("foo") // 可选,CLI 名称,用于生成帮助文本
4344
.scriptName("foo") // CLI 脚本名称
4445
.description("一个 foo CLI") // CLI 描述
4546
.version("0.0.0") // CLI 版本

0 commit comments

Comments
 (0)