tsai
/
abp
mirror of https://github.com/abpframework/abp.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Re-order commands on the CLI document.

pull/4112/head
Halil İbrahim Kalkan 6 years ago
parent
3da0b94263
commit
cf4613d2d1
1 changed files with 69 additions and 71 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 140
      docs/en/CLI.md

140
docs/en/CLI.md
View File

@ -32,6 +32,23 @@ Here, the list of all available commands before explaining their details:
* **`login`**: Authenticates on your computer with your [abp.io](https://abp.io/) username and password.
* **`logout`**: Logouts from your computer if you've authenticated before.
### help
Shows basic usages of the ABP CLI.
Usage:
````bash
abp help [command-name]
````
Examples:
````bash
abp help # Shows a general help.
abp help new # Shows help about the "new" command.
````
### new
Generates a new solution based on the ABP [startup templates](Startup-Templates/Index.md).
@ -77,6 +94,27 @@ abp new Acme.BookStore
* `--connection-string` or `-cs`: Overwrites the default connection strings in all `appsettings.json` files. The default connection string is `Server=localhost;Database=MyProjectName;Trusted_Connection=True;MultipleActiveResultSets=true`. You can set your own connection string if you don't want to use the default. Be aware that the default database provider is `SQL Server`, therefore you can only enter connection string for SQL Server!
* `--local-framework-ref --abp-path`: keeps local references to projects instead of replacing with NuGet package references.
### 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.
Usage:
````bash
abp update [options]
````
* 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 with a .csproj file, it updates all ABP related packages of the project to the latest versions.
#### Options
* `--include-previews` or `-p`: Includes preview, beta and rc packages while checking the latest versions.
* `--npm`: Only updates NPM packages.
* `--nuget`: Only updates NuGet packages.
* `--solution-path` or `-sp`: Specify the solution path. Use the current directory by default
* `--solution-name` or `-sn`: Specify the solution name. Search `*.sln` files in the directory by default.
### add-package
Adds an ABP package to a project by,
@ -131,49 +169,28 @@ abp add-module Volo.Blogging
* `-sp` or `--startup-project`: Relative path to the project folder of the startup project. Default value is the current folder.
* `--with-source-code`: Add source code of the module instead of NuGet/NPM packages.
### update
### generate-proxy
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.
Generates client proxies for your HTTP APIs to make easy to consume your services from the client side. Before running `generate-proxy` command, your host must be up and running.
Usage:
````bash
abp update [options]
abp generate-proxy [options]
````
* 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 with a .csproj file, it updates all ABP related packages of the project to the latest versions.
#### Options
* `--include-previews` or `-p`: Includes preview, beta and rc packages while checking the latest versions.
* `--npm`: Only updates NPM packages.
* `--nuget`: Only updates NuGet packages.
* `--solution-path` or `-sp`: Specify the solution path. Use the current directory by default
* `--solution-name` or `-sn`: Specify the solution name. Search `*.sln` files in the directory by default.
### translate
This command will create a unified json file based on the reference culture. It will search all localized `json` files in the current directory. It will include the localized translations that are missing from the reference culture. You can complete the translation in this `json`(eg: `abp-translation.json`) file.
Finally, use `abp translate --apply` to submit the changes.This command will synchronize your translated text to the localized `json` file in the project. You can view the changes of localized information through git.
* `--apiUrl` or `-a`: Specifies the root URL of the HTTP API. The default value is being retrieved from the `environment.ts` file for the Angular application. Make sure your host is up and running before running `abp generate-proxy`.
* `--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.
Usage:
Example usage with the options:
````bash
abp translate [options]
abp generate-proxy --apiUrl https://localhost:44305 --ui angular --module all
````
#### Options
* `--culture` or `-c`: Target culture. eg: `zh-Hans`
* `--reference-culture` or `-r`: Default `en`
* `--output` or `-o`: Output file name. Default `abp-translation.json`.
* `--all-values` or `-all`: Include all keys. Default `false`
* `--apply` or `-a`: Creates or updates the file for the translated culture.
* `--file` or `-f`: Default: `abp-translation.json`
### switch-to-preview
@ -202,64 +219,45 @@ abp switch-to-stable [options]
`--solution-directory` or `-sd`: Specifies the directory. The solution should be in that directory or in any of its sub directories. If not specified, default is the current directory.
### login
Some features of the CLI requires to be logged in to abp.io platform. To login with your username write:
```bash
abp login <username>
```
```bash
abp login <username> -p <password>
```
Notice that, a new login with an already active session, overwrites the previous session.
### logout
Logs you out by removing the session token from your computer.
```
abp logout
```
### translate
### generate-proxy
This command will create a unified json file based on the reference culture. It will search all localized `json` files in the current directory. It will include the localized translations that are missing from the reference culture. You can complete the translation in this `json`(eg: `abp-translation.json`) file.
Generates client proxies for your HTTP APIs to make easy to consume your services from the client side. Before running `generate-proxy` command, your host must be up and running.
Finally, use `abp translate --apply` to submit the changes.This command will synchronize your translated text to the localized `json` file in the project. You can view the changes of localized information through git.
Usage:
````bash
abp generate-proxy [options]
abp translate [options]
````
#### Options
* `--apiUrl` or `-a`: Specifies the root URL of the HTTP API. The default value is being retrieved from the `environment.ts` file for the Angular application. Make sure your host is up and running before running `abp generate-proxy`.
* `--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.
* `--culture` or `-c`: Target culture. eg: `zh-Hans`
* `--reference-culture` or `-r`: Default `en`
* `--output` or `-o`: Output file name. Default `abp-translation.json`.
* `--all-values` or `-all`: Include all keys. Default `false`
* `--apply` or `-a`: Creates or updates the file for the translated culture.
* `--file` or `-f`: Default: `abp-translation.json`
Example usage with the options:
### login
````bash
abp generate-proxy --apiUrl https://localhost:44305 --ui angular --module all
````
Some features of the CLI requires to be logged in to abp.io platform. To login with your username write:
```bash
abp login <username> # Asks password separately
abp login <username> -p <password> # Specify the password as a parameter
```
### help
> Using `-p` parameter might not be safe if someone is watching your screen :) It can be useful for automation purposes.
Writes basic usage information of the CLI.
A new login with an already active session overwrites the previous session.
Usage:
### logout
````bash
abp help [command-name]
````
Logs you out by removing the session token from your computer.
Examples:
```
abp logout
```
````bash
abp help # Shows a general help.
abp help new # Shows help about the "new" command.
````

Write Preview
Loading…
Cancel
Save