Giter Club home page Giter Club logo

abp-cli's Introduction

Abp-CLI

ABP Command Line Tool.

NuGet version

This command is built following dotnet core global tools.

中文版readme

Install

dotnet tool install -g AbpTools

Usage

Init Solution

abplus init YourProjectName

Example

abplus init FamilySrv.PlanFork

New console or module

abplus new console -n YourProjectName -T personball/abplus-zero-template

Example

abplus new console -n Abplus.Demo -T personball/abplus-zero-template

HelpText

abplus

    $> abplus --help
    1.2.0

    Usage: abplus [options] [command]

    Options:
    --version  Show version information
    --help     Show help information

    Commands:
    init       Init a project from project template.  
    new        Should be executed in aspnet-core folder,   
               and create new console or module in aspnet-core/src folder.

    Run 'abplus [command] --help' for more information about a command.

    $> abplus init --help
    Init a project from project template.

abplus init

    $> abplus init --help
    Init a project from project template.

    Usage: abplus init [arguments] [options]

    Arguments:
    ProjectName         Your project name, default as 'AbpDemo'.

    Options:
    --help              Show help information
    -T|--template-name  TemplateName <GithubUserName>/<RepoName>[@<ReleaseTag>], default as 
                        'aspnetboilerplate/module-zero-core-template@latest'.
    -h|--place-holder   PlaceHolder in project template,default as 'AbpCompanyName.AbpProjectName'.
    -m                  Is this project a Multi-Pages Application? Default as false.
    -t|--spa-type       Choose 'vue' for vuejs or 'ng' for angularjs or 'react' for reactjs.
                        Any invalid value will be replaced by 'vue'.
    -b                  Rename Backup

abplus new

    $> abplus new --help
    Should be executed in aspnet-core folder, and create new console or module in aspnet-core/src folder.

    Usage: abplus new [arguments] [options]

    Arguments:
    Identifier          'console' or 'module'

    Options:
    --help              Show help information
    -n|--name           Name for 'console' like 'AbpCompanyName.AbpProjectName' or for   
                        'module' like 'AbpCompanyName.AbpProjectName.AbpModuleName'
    -T|--template-name  TemplateName <GithubUserName>/<RepoName>[@<ReleaseTag>], default as 
                        'aspnetboilerplate/module-zero-core-template@latest'.
    -h|--placeholder    PlaceHolder in project template,default as 'AbpCompanyName.AbpProjectName'.

More features todo

  1. SubCommand abplus add for code scaffold.
  2. SubCommand abplus set for command config, like default template, default Placeholder.
  3. Other SubCommand.

Project Template Repository Specification

Everyone can custom your own Project Template Repository by fork aspnetboilerplate/module-zero-core-template, and use abplus init -T YourGithubUserName/YourOwnProjectTemplateRepository@tagName to init your project.

But there are two notices:

  1. Manage releases of Your Own Project Template Repository, set a latest tag to latest release, or replace @tagName in command option -T like @v1.2.3
  2. Keep the Folder Structure as below:
    |                               //root
    |-angular                       //optional  
    |-aspnet-core  
        |-src  
            |-{PlaceHolder}.Web.Mvc //MPA project  
    |-reactjs                       //optional  
    |-vue                           //optional  
    |-console                       //Identifier folder for 'abplus new console...'
    |-module                        //Identifier folder for 'abplus new module...'
    //other folders and files not care.  

Local Templates Folder

As Version 1.2.0, abplus will save the template zip file (release of the repository) which download from github in local user's folder '%User%\AppData\Roaming\Abplus' to speed up command execution. For example: C:\Users\perso\AppData\Roaming\Abplus.

MIT

abp-cli's People

Contributors

ltm0203 avatar personball avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

abp-cli's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.