inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-24 17:32:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ACS-6396] cleanup unused CLI code (#9132)

Browse Source 
* cleanup unused CLI code

* [ci:force] update CLI readme
This commit is contained in:
Denys Vuika
2023-11-28 10:20:17 +00:00
committed by GitHub
parent 7300f74add
commit 979bf3ac59
13 changed files with 10 additions and 1705 deletions
Download Patch File Download Diff File Expand all files Collapse all files

107
lib/cli/README.md
View File

@@ -4,7 +4,7 @@ The ADF CLI provides a set of utilities to manage your ADF projects.
## Installation
To get started follow these instructions:
To get started, follow these instructions:
```bash
npm install @alfresco/adf-cli -g
@@ -41,24 +41,15 @@ In develop mode, the CLI takes the prebuilt scripts from the dist folder.
## Commands
| **Commands** |**Description** |
|--- |--- |
| --- | --- |
| changelog | Generate changelog report for two branches of git repository |
|check-cs-env |Check cs env is up |
|check-ps-env |Check ps env is up |
|check-plugin-env |Check plugin status |
|artifact-from-s3 |Get artifact from S3 |
|artifact-to-s3 |Get artifact to S3 |
|docker |Build and publish a docker image or create additional tag link |
|init-aae-env |Init env|
|init-aps-env |Init aps|
|kubectl-delete |delete kubectl |
|kubectl-image |This command allows you to update a specific service on the rancher env with a specific tag |
|npm-publish | publish on npm |
| update-commit-sha | his command allows you to update the commit sha as part of the `package.json`. Your `package.json` must to have an existing property called "commit" |
|update-version |This command allows you to update the adf dependencies and js-api with different versions Update adf libs and js-api with latest alpha|
|licenses |Create a 3th party license file |
|audit |Check the security risk dependency in your package.json |
|scan-env |Scan the environment to show its status |
| check-cs-env | Check cs env is up |
| check-plugin-env | Check plugin status |
| docker | Build and publish a docker image or create additional tag link |
| init-aae-env | Init env |
| init-aps-env | Init aps |
| licenses | Create a 3th party license file |
| audit | Check the security risk dependency in your package.json |
## Examples
@@ -138,6 +129,7 @@ adf-cli audit
```
### Docker
The command provides 2 targets 'Publish' (default value) and 'Link'
Publish target
@@ -159,77 +151,6 @@ In case you don't need to publish a new image but you would like to create a lin
adf-cli docker --target "link" --dockerRepo "${docker_repository}" --dockerTags "${TAGS}" --sourceTag "develop"
```
### Kubectl update pod image
This command allows you to update a specific service on the rancher env with a specific tag
```bash
adf-cli kubectl-image --clusterEnv ${clusterEnv} --clusterUrl ${clusterUrl} --username ${username} --token ${token} --deployName ${deployName} --dockerRepo ${dockerRepo} --tag ${tag}
```
You can use the option --installCheck to install kubectl as part of the command
### update version
This command allows you to update the adf dependencies and js-api with different versions
Update adf libs and js-api with latest alpha
```bash
adf-cli update-version --alpha --pathPackage "$(pwd)"
```
Update adf libs and js-api with latest beta
```bash
adf-cli update-version --beta --pathPackage "$(pwd)"
```
Update adf libs and js-api with latest
```bash
adf-cli update-version --latest --pathPackage "$(pwd)"
```
Update only adf libs with a specific version
```bash
adf-cli update-version --version "3.2.0-fa5916ff413131513c3e382d7f27dd9b4cfa0e7e" --pathPackage "$(pwd)"
```
Update only js-api with a specific version
```bash
adf-cli update-version --vjs "3.2.0-fa5916ff413131513c3e382d7f27dd9b4cfa0e7e" --pathPackage "$(pwd)"
```
Update adf libs and js-api with latest alpha locally
```bash
adf-cli update-version --alpha --pathPackage "$(pwd)" --skipGnu
```
### Update commit sha
This command allows you to update the commit sha as part of the `package.json`.
Your `package.json` must to have an existing property called "commit"
```bash
adf-cli update-commit-sha --pathProject "$(pwd)"
```
You can use the option --pointer to chose a different pointer from the default HEAD.
```bash
adf-cli update-commit-sha --pointer "HEAD~1" --pathProject "$(pwd)"
```
Run command locally
```bash
adf-cli update-commit-sha --pathProject "$(pwd)" --skipGnu
```
### Initialize activiti cloud env
The following command is in charge of Initializing the activiti cloud env with the default apps:
@@ -264,11 +185,3 @@ The following command is in charge of checking plugin status by given plugin nam
adf-cli check-plugin-env --host "gateway_env" --pluginName "Name of the plugin" --clientId "clientId" --appName "appName" -u "username" -p "password"
--ui "uiName"
```
### Scan the environment
The following command will scan the environment to show various information on its current status:
```bash
adf-cli scan-env --host "https://example.com" --clientId "clientId" -u "admin" -p "password"
```