How to Create Projects from Custom Template #10060

1 Answer(s)

• 

  0

  AI-Bot created yesterday

  Support Team ABP Agent

  1. Solution

  • Current status (ABP Studio CLI 9.2.x): There is no supported way to drop a custom ZIP into ~/.abp/templates or to point ABP Studio CLI to a custom template folder. That directory is a managed download cache and is overwritten by clear-download-cache and by template updates. Overriding the built-in template download behavior is not supported.

  • Recommended, supportable approaches to standardize your organization’s starting point:

    1. Create an Organization Base Solution once, and reuse it

       • Create a new solution with the official template that matches your target ABP/Commercial version (e.g., app-pro for Commercial).
       • Apply all organization-wide changes (base classes, conventions, utility code, settings, CI files, common modules/packages, theme defaults, etc.).
       • Store it in your internal Git repo as a seed project.
       • Workflow for new projects:
         • Clone the base solution as a new repo.
         • Rename namespaces, solution and project names with your own script or tooling.
         • Update Solution Configuration (if needed) and run migrations.
       • Pros: 100% control; survives upgrades; no reliance on CLI “custom templates.”
       • Notes: Keep the base solution synchronized with ABP version updates you plan to use in new projects.

    2. Package your reusable code into modules and NuGet/npm packages

       • Move base classes, common abstractions, shared UI pieces, and utilities into one or more internal ABP modules (backend NuGet packages and, if Angular, npm packages).
       • Start new projects from the official template and immediately add your internal modules via abp add-package / dotnet add package (and Angular equivalents).
       • Pros: Keeps startup templates standard and upgrades simpler; consistent reuse across solutions.

    3. ABP Suite/Studio automation (optional)

       • Use ABP Suite for repetitive CRUD scaffolding and conventions, and keep your customizations in modules and post-create scripts.
       • This does not replace a “custom template,” but reduces manual steps right after creation.

  • ABP CLI vs ABP Studio CLI regarding templates:

    • The legacy ABP CLI (Volo.Abp.Cli) historically supported template source configuration in some older docs, but the current ABP Studio CLI manages and downloads official templates by version. Using the old CLI alongside Studio is not recommended for creating Commercial solutions in 9.x. The Studio CLI is the supported path for project creation and will still not load user ZIPs from ~/.abp/templates.
    • Practical guidance: Do not install or rely on the legacy CLI to inject custom templates. Use the base-solution or reusable-module approaches above.

  • Answer to your specific attempts:

    • Placing app-pro-9.2.0.zip under ~/.abp/templates: Not supported; cache is controlled by the CLI and will be ignored/overwritten.
    • clear-download-cache: Correct observation; it confirms the folder is a managed cache, not an extension point.

  • Minimal example of an internal module approach

  [DependsOn(
        typeof(AbpIdentityApplicationModule) // and other dependencies your base module needs
    )]
    public class MyCompanyBaseApplicationModule : AbpModule
    {
        public override void ConfigureServices(ServiceConfigurationContext context)
        {
            // Configure organization-wide conventions, object mappers, settings, etc.
        }
    }
  

  Then in a newly created project:

  • Add a package reference to MyCompany.Base.Application (NuGet).
  • Add DependsOn(typeof(MyCompanyBaseApplicationModule)) to the Application module.
  • For UI (Angular), publish @myco/abp-ui packages and add them right after creation.

  2. Sources

  • ABP GitHub (general reference for official modules and template practices)
    • https://github.com/abpframework/abp
  • ABP Suite (commercial scaffolding, complements base-solution/module approach)
    • https://abp.io/docs/latest/abp-suite

  ---

  This response was generated by AI. If it didn’t solve your problem, feel free to post a new answer — our support team will jump in to help you soon.

  Save Cancel