From c7c1aa28928172f3edcd245b6727472cd176a93f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Halil=20=C4=B0brahim=20Kalkan?= Date: Thu, 19 Mar 2020 19:33:12 +0300 Subject: [PATCH] Update CLI.md --- docs/en/CLI.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/en/CLI.md b/docs/en/CLI.md index 837ba26a11..2b4864efc7 100644 --- a/docs/en/CLI.md +++ b/docs/en/CLI.md @@ -22,7 +22,7 @@ dotnet tool update -g Volo.Abp.Cli Generates a new solution based on the ABP [startup templates](Startup-Templates/Index.md). -Basic usage: +Usage: ````bash abp new [options] @@ -94,7 +94,7 @@ Adds a [multi-package application module](Modules/Index) to a solution by findin > 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. -Basic usage: +Usage ````bash abp add-module [options] @@ -180,26 +180,26 @@ abp logout ### generate-proxy -Generates typescript service proxies and DTOs +Generates client proxies for your HTTP APIs to make easy to consume your services from the client side. -Basic usage: +Usage: ````bash abp generate-proxy [options] ```` -Example: +#### Options + +* `--apiUrl` or `-a`: Specifies the root URL of the HTTP API. The default value is retrieved from the `environment.ts` file for an Angular application. +* `--ui` or `-u`: Specifies the UI framework. Default value is `angular` and it is the only UI framework supported for now. Creates TypeScript code. +* `--module` or `-m`: Specifies the module name. Default module name is `app`, which indicates your own application (you typically want this since every module is responsible to maintain its own client proxies). Set `all` for to generate proxies for all the modules. + +Example usage with the options: ````bash abp generate-proxy --apiUrl https://localhost:44305 --ui angular --module all ```` -#### Options - -* `--apiUrl` or `-a`: If you don't give this option, the default api url in your environment.ts file is used, but you can always use a specific api source with this option. -* `--ui` or `-u`: Specifies the UI framework. Default framework is angular. Currently there is only angular option, but we will increase the options with our new cli updates. Stay tuned! -* `--module` or `-m`: Specifies the module name. Default module name is app. If you want to all modules. You can give `--module all` command. - ### help