命令行
Perigon 提供命令行工具 perigon，用于创建解决方案、补充资源、生成代码、打包模块、安装模块，以及启动 Studio 或 MCP 服务。
快速开始
查看命令总览：
perigon -h
查看某个命令的详细帮助：
perigon <command> -h
例如：
perigon add -h perigon generate request -h
命令概览
当前 perigon -h 输出的主要命令如下：
| 命令 | 说明 |
|---|---|
new <name> |
创建新的 .NET 解决方案 |
add |
向当前解决方案中添加资源 |
studio |
启动 Perigon Studio |
generate |
执行代码生成 |
mcp |
提供 Model Context Protocol 相关工具 |
pack <ModuleName> <ServiceName> |
将模块打包为 zip 文件 |
install <PackagePath> <ServiceName> |
将模块包安装到项目中 |
new
new 命令用于创建新的解决方案，效果与通过 Studio 图形界面创建基本一致。
perigon new <name>
示例：
perigon new DemoApp
帮助信息：
DESCRIPTION:
Create new .NET solution
USAGE:
perigon new <name> [OPTIONS]
EXAMPLES:
perigon new name
ARGUMENTS:
<name> Solution Name
OPTIONS:
-h, --help Prints help information
执行后，CLI 会引导你完成解决方案初始化，例如：
- 选择数据库类型，例如
SqlServer、PostgreSQL - 选择缓存类型
- 选择前端集成方式
- 指定输出目录，默认使用当前目录
- 确认配置并开始生成
add
add 是新增命令，用于在当前解决方案中创建模块以及服务。
perigon add [OPTIONS] <COMMAND>
示例：
perigon add module FileManagerMod perigon add service AdminService
帮助信息：
DESCRIPTION:
Add resources to the current solution
USAGE:
perigon add [OPTIONS] <COMMAND>
EXAMPLES:
perigon add module FileManagerMod
perigon add service AdminService
OPTIONS:
-h, --help Prints help information
COMMANDS:
module <ModuleName> Create a new module in the current solution
service <ServiceName> Create a new service in the current solution
add module
创建一个新模块：
perigon add module <ModuleName>
示例：
perigon add module FileManagerMod
说明：
ModuleName为模块名称- 可以省略
Mod后缀，CLI 会自动处理
帮助信息：
DESCRIPTION:
Create a new module in the current solution
USAGE:
perigon add module <ModuleName> [OPTIONS]
EXAMPLES:
perigon add module FileManagerMod
ARGUMENTS:
<ModuleName> Module name, `Mod` suffix is optional / 模块名称，可省略 `Mod` 后缀
OPTIONS:
-h, --help Prints help information
add service
创建一个新服务：
perigon add service <ServiceName>
示例：
perigon add service AdminService
说明：
ServiceName为服务名称
帮助信息：
DESCRIPTION:
Create a new service in the current solution
USAGE:
perigon add service <ServiceName> [OPTIONS]
EXAMPLES:
perigon add service AdminService
ARGUMENTS:
<ServiceName> Service name / 服务名称
OPTIONS:
-h, --help Prints help information
studio
studio 命令用于启动 Perigon Studio。大多数可视化操作都可以在 Studio 中完成。
perigon studio
帮助信息：
DESCRIPTION:
start Perigon Studio
USAGE:
perigon studio [OPTIONS] [COMMAND]
OPTIONS:
-h, --help Prints help information
COMMANDS:
update update studio
studio update
用于更新 Studio：
perigon studio update
帮助信息：
DESCRIPTION:
update studio
USAGE:
perigon studio update [OPTIONS]
OPTIONS:
-h, --help Prints help information
generate
generate 命令用于执行代码生成。
perigon generate [OPTIONS] <COMMAND>
当前主要支持客户端请求服务和模型文件的生成。
帮助信息：
DESCRIPTION:
Code generate
USAGE:
perigon generate [OPTIONS] <COMMAND>
EXAMPLES:
perigon generate request ./openapi.json ./src/services -t angular
OPTIONS:
-h, --help Prints help information
COMMANDS:
request <path|url> <outputPath> Generate client request service and models
generate request
根据 OpenAPI 文档生成客户端请求服务和模型。
perigon generate request <path|url> <outputPath> [OPTIONS]
示例：
perigon generate request https://localhost:17001/swagger/v1/swagger.json ./src/services -t angular
帮助信息：
DESCRIPTION:
Generate client request service and models
USAGE:
perigon generate request <path|url> <outputPath> [OPTIONS]
EXAMPLES:
perigon generate request ./openapi.json ./src/services -t angular
ARGUMENTS:
<path|url> Local path or url, support json format
<outputPath> The output path
OPTIONS:
DEFAULT
-h, --help Prints help information
-t, --type angular Support types: csharp/angular/axios, default: angular
-m, --only-model false Only generate model files
参数说明：
<path|url>：本地 OpenAPI 文件路径或远程 URL<outputPath>：生成代码的输出目录-t, --type：生成目标类型，支持csharp、angular、axios-m, --only-model：仅生成模型文件
mcp
mcp 命令用于 Perigon 的 Model Context Protocol 工具。
perigon mcp [OPTIONS] <COMMAND>
帮助信息：
DESCRIPTION:
Model Context Protocol tools
USAGE:
perigon mcp [OPTIONS] <COMMAND>
OPTIONS:
-h, --help Prints help information
COMMANDS:
config Print MCP stdio config JSON
start Start MCP server with stdio transport
mcp config
输出 MCP 的 stdio 配置 JSON：
perigon mcp config
帮助信息：
DESCRIPTION:
Print MCP stdio config JSON
USAGE:
perigon mcp config [OPTIONS]
OPTIONS:
-h, --help Prints help information
mcp start
以 stdio 方式启动 MCP 服务：
perigon mcp start
帮助信息：
DESCRIPTION:
Start MCP server with stdio transport
USAGE:
perigon mcp start [OPTIONS]
OPTIONS:
-h, --help Prints help information
pack
pack 命令用于将模块打包为 zip 文件。
perigon pack <ModuleName> <ServiceName>
示例：
perigon pack FileManagerMod AdminService
帮助信息：
DESCRIPTION:
Package module as zip file
USAGE:
perigon pack <ModuleName> <ServiceName> [OPTIONS]
EXAMPLES:
perigon pack FileManagerMod AdminService
ARGUMENTS:
<ModuleName> Module name (with Mod suffix)
<ServiceName> Service name in Services directory
OPTIONS:
-h, --help Prints help information
参数说明：
ModuleName：模块名称，通常以Mod结尾ServiceName：服务名称，对应Services目录下的某个 API 服务目录
install
install 命令用于将模块包安装到项目中。
perigon install <PackagePath> <ServiceName>
示例：
perigon install ./package_modules/FileManagerMod.zip AdminService
帮助信息：
DESCRIPTION:
Install module package to project
USAGE:
perigon install <PackagePath> <ServiceName> [OPTIONS]
EXAMPLES:
perigon install ./package_modules/FileManagerMod.zip AdminService
ARGUMENTS:
<PackagePath> Path to the module package zip file
<ServiceName> Service name in Services directory
OPTIONS:
-h, --help Prints help information
参数说明：
PackagePath：模块压缩包路径ServiceName：目标服务名称，对应Services目录下的某个 API 服务目录
说明
- 命令说明以当前版本 CLI 的
perigon -h及各子命令帮助输出为准。 - 如果后续版本新增命令或参数，建议重新执行
perigon -h与perigon <command> -h后同步更新文档。