-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Jintao Zhang <[email protected]>
- Loading branch information
1 parent
5aa9497
commit e53e087
Showing
1 changed file
with
10 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,33 +1,33 @@ | ||
| # ADC | ||
|
|
||
| The ADC CLI tool is a command-line interface for interacting with the API7 API. It is built using the Golang Cobra library and provides several sub-commands for managing your API7 account. | ||
| The ADC CLI tool is a command-line interface for interacting with the APISIX's API. It is built using the Golang Cobra library and provides several sub-commands for managing your APISIX instance. | ||
|
|
||
| ## Usage | ||
|
|
||
| To use the ADC CLI tool, run the `adc` command followed by the sub-command you wish to use. For example, to ping the API7 API, run the following command: | ||
| To use the ADC CLI tool, run the `adc` command followed by the sub-command you wish to use. For example, to check the connection to APISIX API, run the following command: | ||
|
|
||
| ``` | ||
| adc ping | ||
| ``` | ||
|
|
||
| This will verify the connection to the ADC API and print a success message. | ||
| This will verify the connection to the APISIX API and print a success message. | ||
|
|
||
| The following sub-commands are available: | ||
|
|
||
| - `ping`: Verify the connection to the ADC API. | ||
| - `sync`: Sync your local data with the ADC API. | ||
| - `diff`: Show the differences between your local data and the ADC API. | ||
| - `dump`: Dump your local data to a file. | ||
| - `configure`: Configure the ADC CLI tool. | ||
| - `configure`: Configure the ADC CLI tool with the APISIX's server address and token. | ||
| - `ping`: Verify the connection to the APISIX API. | ||
| - `sync`: Sync your local configuration to APISIX instance. | ||
| - `diff`: Show the differences between your local configuration and the APISIX instance. | ||
| - `dump`: Dump your APISIX configurations to a local file. | ||
|
|
||
| Use the `--help` flag with any sub-command to see its usage information. | ||
|
|
||
| ## Configuration | ||
|
|
||
| The ADC CLI tool can be configured using the `configure` sub-command. This sub-command will prompt you for your ADC server address and API token, and save them to a configuration file. | ||
| The ADC CLI tool can be configured using the `configure` sub-command. This sub-command will prompt you for your APISIX server address and API token, and save them to a configuration file. | ||
|
|
||
| The configuration file is located at `$HOME/.adc.yaml` and can be edited manually if necessary. | ||
|
|
||
| ## License | ||
|
|
||
| This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. | ||
| This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. |