ABP CLI

Introducing ABP CLI:

Your command line companion for seamless project creation.

ABP CLI (Command Line Interface) is a command line tool to perform some common operations for ABP based solutions.

See Documentation

CORE COMMANDS

Explore the versatile functionality of ABP Command Line Interface.

new

Generates a new solution based on the ABP startup templates.

Usage:


                abp new <solution-name> [options]
        

Example:


                > abp new Acme.BookStore
            
  • Acme.BookStore is the solution name here.
  • Common convention is to name a solution is like YourCompany.YourProject. However, you can use different naming like YourProject (single level namespacing) or YourCompany.YourProduct.YourModule (three levels namespacing).

For more samples, go to ABP CLI Create Solution Samples

update

Updating all ABP related packages can be tedious since there are many packages of the framework and modules. This command automatically updates all ABP related NuGet and NPM packages in a solution or project to the latest versions. You can run it in the root folder of your solutions.

Usage:


                abp update [options]
            
  • If you run in a directory with a .csproj file, it updates all ABP related packages of the project to the latest versions.
  • If you run in a directory with a .sln file, it updates all ABP related packages of the all projects of the solution to the latest versions.
  • If you run in a directory that contains multiple solutions in sub-folders, it can update all the solutions, including Angular projects.

Note that this command can upgrade your solution from a previous version, and also can upgrade it from a preview release to the stable release of the same version.

switch-to-preview

You can use this command to switch your solution or project to latest preview version of the ABP framework.

Usage:


                abp switch-to-preview [options]
            

add-module

Adds a multi-package application module to a solution by finding all packages of the module, finding related projects in the solution and adding each package to the corresponding project in the solution.

It can also create a new module for your solution and add it to your solution. See --new option.

A business module generally consists of several packages (because of layering, different database provider options or other reasons). Using add-module command dramatically simplifies adding a module to a solution. However, each module may require some additional configurations which is generally indicated in the documentation of the related module.

Usage:


                abp add-module <module-name> [options]
            

Examples:


                abp add-module Volo.Blogging
            
  • This example adds the Volo.Blogging module to the solution.

                abp add-module ProductManagement --new --add-to-solution-file   
            
  • This command creates a fresh new module customized for your solution (named ProductManagement) and adds it to your solution.

Utility Commands

Useful utility commands simplifies your development flow with ABP

See More