@ -16,6 +16,12 @@ dotnet tool install -g Volo.Abp.Cli
dotnet tool update -g Volo.Abp.Cli
````
## 全局选项
虽然每个命令可能都有一组选项,但有些全局选项可以与任何命令一起使用:
* `--skip-cli-version-check` : 跳过检查最新版本的ABP CLI. 如果没有指定,它会检查最新版本,如果检查到ABP CLI的新版本,会显示一条警告消息.
## Commands
这里是所有可用的命令列表:
@ -25,7 +31,9 @@ dotnet tool update -g Volo.Abp.Cli
* ** `update` **：自动更新的ABP解决方案ABP相关的NuGet和NPM包.
* ** `add-package` **: 添加ABP包到项目.
* ** `add-module` **: 添加[应用模块](https://docs.abp.io/en/abp/latest/Modules/Index)到解决方案.
* ** `generate-proxy` **: 生成客户端代理以使用服务器上的HTTP API端点.
* ** `generate-proxy` **: 生成客户端代理以使用HTTP API端点.
* ** `remove-proxy` **: 移除以前生成的客户端代理.
* ** `switch-to-preview` **: 切换到ABP框架的最新预览版本。
* ** `switch-to-preview` **: 切换解决方案所有ABP相关包为[夜间构建](Nightly-Builds.md)版本.
* ** `switch-to-stable` **: 切换解决方案所有ABP相关包为最新的稳定版本.
* ** `translate` **: 当源代码控制存储库中有多个JSON[本地化]（Localization.md文件时,可简化翻译本地化文件的过程.
@ -90,12 +98,33 @@ abp new Acme.BookStore
* * *`console`**: [Console template ](Startup-Templates/Console.md ).
* `--output-folder` 或者 `-o` : 指定输出文件夹,默认是当前目录.
* `--version` 或者 `-v` : 指定ABP和模板的版本.它可以是 [release tag ](https://github.com/abpframework/abp/releases ) 或者 [branch name ](https://github.com/abpframework/abp/branches ). 如果没有指定,则使用最新版本.大多数情况下,你会希望使用最新的版本.
* `--preview` : 使用最新的预发行版本 (仅在未指定 `--version` 且最新稳定版本之后至少有一个预发行版时) .
* `--preview` : 使用最新的预览版本 .
* `--template-source` 或者 `-ts` : 指定自定义模板源用于生成项目,可以使用本地源和网络源(例如 `D:\local-templat` 或 `https://.../my-template-file.zip` ).
* `--create-solution-folder` 或者 `-csf` : 指定项目是在输出文件夹中的新文件夹中还是直接在输出文件夹中.
* `--connection-string` 或者 `-cs` : 重写所有 `appsettings.json` 文件的默认连接字符串. 默认连接字符串是 `Server=localhost;Database=MyProjectName;Trusted_Connection=True;MultipleActiveResultSets=true` . 默认的数据库提供程序是 `SQL Server` . 如果你使用EF Core但需要更改DBMS,可以按[这里所述](Entity-Framework-Core-Other-DBMS.md)进行更改(创建解决方案之后).
* `--local-framework-ref --abp-path` : 使用对项目的本地引用,而不是替换为NuGet包引用.
### update
更新所有ABP相关的包可能会很繁琐,框架和模块都有很多包. 此命令自动将解决方案或项目中所有ABP相关的包更新到最新版本.
用法:
````bash
abp update [options]
````
* 如果你的文件夹中有.sln文件,运行命令会将解决方案中所有项目ABP相关的包更新到最新版本.
* 如果你的文件夹中有.csproj文件,运行命令会将项目中所有ABP相关的包更新到最新版本.
#### Options
* `--npm` : 仅更新NPM包
* `--nuget` : 仅更新的NuGet包
* `--solution-path` 或 `-sp` : 指定解决方案路径/目录. 默认使用当前目录
* `--solution-name` 或 `-sn` : 指定解决方案名称. 默认在目录中搜索`*.sln`文件.
*`--check-all`: 分别检查每个包的新版本. 默认是 `false` .
### add-package
通过以下方式将ABP包添加到项目中
@ -150,105 +179,157 @@ abp add-module Volo.Blogging
* `-sp` 或 `--startup-project` : 启动项目的项目文件夹的相对路径. 默认值是当前文件夹.
* `--with-source-code` : 添加模块的源代码,而不是NuGet/NPM软件包.
### update
### generate-proxy
更新所有ABP相关的包可能会很繁琐,框架和模块都有很多包. 此命令自动将解决方案或项目中所有ABP相关的包更新到最新版本 .
为您的HTTP API生成Angular服务代理,简化从客户端使用服务的成本. 在运行此命令之前,你的host必须启动正在运行 .
用法:
````bash
abp update [options]
abp generate-proxy
````
* 如果你的文件夹中有.sln文件,运行命令会将解决方案中所有项目ABP相关的包更新到最新版本.
* 如果你的文件夹中有.csproj文件,运行命令会将项目中所有ABP相关的包更新到最新版本.
#### Options
* `--include-previews` 或 `-p` : 将预览版, 测试版本 和 rc 包 同时更新到最新版本.
* `--npm` : 仅更新NPM包
* `--nuget` : 仅更新的NuGet包
* `--solution-path` 或 `-sp` : 指定解决方案路径/目录. 默认使用当前目录
* `--solution-name` 或 `-sn` : 指定解决方案名称. 默认在目录中搜索`*.sln`文件.
*`--check-all`: 分别检查每个包的新版本. 默认是 `false` .
### 切换到每晚构建(预览)包
* `--module` 或 `-m` : 指定要为其生成代理的后端模块的名称. 默认值: `app` .
* `--api-name` 或 `-a` : 在 `/src/environments/environment.ts` 中定义的API端点名称。. 默认值: `default` .
* `--source` 或 `-s` : 指定解析根名称空间和API定义URL的Angular项目名称. 默认值: `defaultProject`
* `--target` 或 `-t` : 指定放置生成的代码的Angular项目名称. 默认值: `defaultProject` .
* `--prompt` 或 `-p` : 在命令行提示符下询问选项(未指定的选项).
想要切换到ABP框架的最新**每晚构建**预览版可以使用此命令 .
> 参阅 [Angular服务代理文档 ](UI/Angular/Service-Proxies.md ) 了解更多.
用法:
### remove-proxy
````bash
abp switch-to-nightly [options]
````
从Angular应用程序中删除以前生成的代理代码. 在运行此命令之前,你的host必须启动正在运行.
你也可以使用切换回最新稳定版本:
This can be especially useful when you generate proxies for multiple modules before and need to remove one of them later.
Usage:
````bash
abp switch-to-stable [options]
abp remove-proxy
````
#### Options
`--solution-directory` 或 `-sd` : 指定解决方案文件夹. 解决方案应该在指定文件夹或子文件夹中. 如果未指定,默认为当前目录.
* `--module` 或 `-m` : 指定要为其生成代理的后端模块的名称. 默认值: `app` .
* `--api-name` 或 `-a` : 在 `/src/environments/environment.ts` 中定义的API端点名称。. 默认值: `default` .
* `--source` 或 `-s` : 指定解析根名称空间和API定义URL的Angular项目名称. 默认值: `defaultProject`
* `--target` 或 `-t` : 指定放置生成的代码的Angular项目名称. 默认值: `defaultProject` .
* `--prompt` 或 `-p` : 在命令行提示符下询问选项(未指定的选项).
### login
> 参阅 [Angular服务代理文档 ](UI/Angular/Service-Proxies.md ) 了解更多.
CLI的一些功能需要登录到abp.io平台. 使用你的用户名登录
### switch-to-preview
```bash
abp login < username >
```
你可以使用此命令将项目切换到ABP框架的最新预览版本.
```bash
abp login < username > -p < password >
```
请注意,新的登录将终止先前的会话并创建一个新的会话.
### logout
用法:
通过从计算机中删除会话令牌来注销.
````bash
abp switch-to-preview [options]
````
```
abp logout
```
#### Options
### generate-proxy
* `--solution-directory` 或 `-sd` : 指定目录. 解决方案应该在该目录或其子目录中. 如果未指定默认为当前目录.
### switch-to-nightly
为你的HTTP API生成客户端代码,简化客户端使用服务的成本. 在运行 `generate-proxy` 命令之前,你的host必须启动正在运行.
想要切换到ABP框架的最新[每晚构建](Nightly-Builds.md)预览版可以使用此命令 .
用法:
````bash
abp generate-prox y [options]
abp switch-to-nightl y [options]
````
#### Options
* `--apiUrl` 或者 `-a` :指定HTTP API的根URL. 如果未指定这个选项,默认使用你Angular应用程序的`environment.ts`文件API URL. 在运行 `generate-proxy` 命令之前,你的host必须启动正在运行.
* `--ui` 或者 `-u` : 指定UI框架,默认框架是angular.当前只有angular一个选项, 但我们会通过更改CLI增加新的选项. 尽请关注!
* `--module` 或者 `-m` :指定模块名. 默认模块名称为app. 如果你想所有模块,你可以指定 `--module all` 命令.
`--solution-directory` 或 `-sd` : 指定目录. 解决方案应该在该目录或其子目录中. 如果未指定默认为当前目录.
示例:
### switch-to-stable
如果你使用的是ABP框架预览包(包括每晚构建),可以使用此命令切换回最新的稳定版本.
用法:
````bash
abp generate-proxy --apiUrl https://localhost:44305 --ui angular --module all
abp switch-to-stable [options]
````
#### Options
### help
`--solution-directory` 或 `-sd` : 指定目录. 解决方案应该在该目录或其子目录中. 如果未指定默认为当前目录.
CLI的基本用法信息.
### translate
用法:
源代码控制存储库中有多个JSON[本地化](Localization.md)文件时,用于简化翻译[本地化](Localization.md)文件的过程.
* 该命令将基于参考文化创建一个统一的json文件
* 它搜索当前目录和所有子目录中的所有本地化"JSON"文件(递归). 然后创建一个包含所有需要翻译的条目的文件(默认情况下名为 "abp-translation.json").
* 翻译了此文件中的条目后,你就可以使用 `--apply` 命令将更改应用于原始本地化文件.
> 该命令的主要目的是翻译ABP框架本地化文件(因为[abp仓库](https://github.com/abpframework/abp)包括数十个要在不同目录中转换的本地化文件).
#### 创建翻译文件
第一步是创建统一的翻译文件:
````bash
abp help [命令名]
abp translate -c < culture > [options ]
````
示例:
````bash
abp help # 显示常规帮助.
abp help new # 显示有关 "New" 命令的帮助.
abp translate -c de-DE
````
该命令为 `de-DE` (德语)文化创建了统一的翻译文件.
##### 附加选项
* `--reference-culture` 或 `-r` : 默认值 `en` . 指定参考文化.
* `--output` 或 `-o` : 输出文件名. 默认值 `abp-translation.json` .
* `--all-values` 或 `-all` : 包括所有要翻译的键. 默认情况下,统一翻译文件仅包含目标文化的缺失文本. 如果你可能需要修改之前已经翻译的值,请指定此参数.
#### 应用更改
翻译完统一翻译文件中的条目后,你可以使用 `--apply` 参数将更改应用于原始本地化文件:
````bash
abp translate --apply # apply all changes
abp translate -a # shortcut for --apply
````
然后,检查源代码控制系统上的更改,以确保它已更改了正确的文件. 如果你翻译了ABP框架资源, 请发送 "Pull Request". 提前感谢你的贡献.
##### 附加选项
* `--file` 或 `-f` : 默认值: `abp-translation.json` . 翻译文件(仅在之前使用过 `--output` 选项时使用).
### login
CLI的一些功能需要登录到abp.io平台. 使用你的用户名登录
```bash
abp login < username > # Allows you to enter your password hidden
abp login < username > -p < password > # Specify the password as a parameter (password is visible)
abp login < username > --organization < organization > # If you have multiple organizations, you need set your active organization
abp login < username > -p < password > -o < organization > # You can enter both your password and organization in the same command
```
> 当使用-p参数,请注意,因为你的密码是可见的. 它对于CI / CD自动化管道很有用.
请注意,新的登录将终止先前的会话并创建一个新的会话.
### logout
通过从计算机中删除会话令牌来注销.
```
abp logout
```
maliming
6 years ago
GitHub
