ABP CLI
2023-11-15 #abp

ABP CLI

安装

ABP CLI 是一个 dotnet global tool. 使用命令行窗口安装:

dotnet tool install -g Volo.Abp.Cli

更新最新版本:

dotnet tool update -g Volo.Abp.Cli

Commands

这里是所有可用的命令列表:

  • help: 展示ABP CLI的用法帮助信息.
  • new：生成基于ABP的启动模板.
  • update：自动更新的ABP解决方案ABP相关的NuGet和NPM包.
  • clean: 删除当前目录下所有的 BIN 和 OBJ 子目录.
  • add-package: 添加ABP包到项目.
  • add-module: 添加应用模块到解决方案.
  • list-modules: 列出开源应用模块名称
  • switch-to-preview: 切换到ABP框架的最新预览版本。
  • switch-to-stable: 切换解决方案所有ABP相关包为最新的稳定版本.

update

更新所有ABP相关的包可能会很繁琐,框架和模块都有很多包. 此命令自动将解决方案或项目中所有ABP相关的包更新到最新版本.

用法:

abp update [options]
  • 如果你的文件夹中有.sln文件,运行命令会将解决方案中所有项目ABP相关的包更新到最新版本.
  • 如果你的文件夹中有.csproj文件,运行命令会将项目中所有ABP相关的包更新到最新版本.

Options

  • --npm: 仅更新NPM包
  • --nuget: 仅更新的NuGet包
  • --solution-path 或 -sp: 指定解决方案路径/目录. 默认使用当前目录
  • --solution-name 或 -sn: 指定解决方案名称. 默认在目录中搜索*.sln文件.
  • --check-all: 分别检查每个包的新版本. 默认是 false.
  • --version or -v: 指定用于升级的版本. 如果没有指定,则使用最新版本.

add-module

通过查找模块的所有包,查找解决方案中的相关项目,并将每个包添加到解决方案中的相应项目,从而将多包应用程序模块添加到解决方案中.

由于分层,不同的数据库提供程序选项或其他原因,业务模块通常由多个包组成. 使用add-module命令可以大大简化向模块添加模块的过程. 但是每个模块可能需要一些其他配置,这些配置通常在相关模块的文档中指出.

用法:

abp add-module <模块名称> [options]

示例:

abp add-module Volo.Blogging
  • 示例中将Volo.Blogging模块添加到解决方案中.

Options

  • --solution 或 -s: 指定解决方案 (.sln) 路径. 如果未指定,CLI会尝试在当前目录中寻找.sln文件.
  • --skip-db-migrations: 对于EF Core 数据库提供程序,它会自动添加新代码的第一次迁移 (Add-Migration) 并且在需要时更新数据库 (Update-Database). 指定此选项可跳过此操作.
  • -sp 或 --startup-project: 启动项目的项目文件夹的相对路径. 默认值是当前文件夹.
  • --with-source-code: 添加模块的源代码,而不是NuGet/NPM软件包.
  • --add-to-solution-file: 添加下载/创建的模块添加到解决方案文件中,你在IDE中打开解决方案时也会看到模块的项目. (仅当 --with-source-code 为 True 时可用.)

栗子:

add-module Volo.Account --with-source-code --skip-db-migrations --add-to-solution-file

上一页