Skip to content

Commit b3281fd

Browse files
committed
Fixed review comments from Kevin and Varsha
Signed-off-by: Anand Francis Joseph <[email protected]>
1 parent 8bc36ab commit b3281fd

File tree

1 file changed

+8
-20
lines changed

1 file changed

+8
-20
lines changed

docs/OpenShift GitOps CLI User Guide.md

Lines changed: 8 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -199,17 +199,14 @@ In the normal mode (default mode), the `argocd` CLI client makes API requests to
199199
eg:
200200
```
201201
# get the admin password and use it by enclosing in single quotes.
202-
# echo ${ADMIN_PASSWD}
203202
# argocd login --username admin --password '<password>' openshift-gitops.openshift-gitops.apps-crc.testing
204203
```
205204
**IMPORTANT** passwords can contain special characters like `$` which would be interpreted as shell variables. This can cause the command to fail as a wrong value (shell interpreted) of password would be sent to the server. Always use single quotes '' to enclose the actual value of the password to avoid such errors.
206-
3. Execute the argocd commands
207-
```
208-
# argocd [command or options] [arguments…​]
205+
206+
Upon successful login, the context that would be used for the session would be displayed as below.
209207
```
210-
eg:
211-
```
212-
# argocd app list
208+
'admin:login' logged in successfully
209+
Context '<server_url>' updated
213210
```
214211
215212
#### Core mode
@@ -308,7 +305,7 @@ Print version information
308305
```
309306
- Print only full version of the server
310307
```
311-
# argocd version --server openshift-gitops.openshift-gitops.crc.local
308+
# argocd version --server <server_url>
312309
```
313310
- Print the full version of client and server in JSON format
314311
```
@@ -344,20 +341,14 @@ Write bash or zsh shell completion code to standard output.
344341
For bash, ensure you have bash completions installed and enabled.
345342
To access completions in your current shell, run the following command
346343
```
347-
$ source <(argocd completion bash)
344+
# source <(argocd completion bash)
348345
```
349346
Alternatively, write it to a file and source in `.bash_profile`
350347
351348
For zsh, add the following to your `~/.zshrc` file:
352349
```
353-
$ source <(argocd completion zsh)
354-
$ compdef _argocd argocd
355-
```
356-
Optionally, also add the following, in case you are getting errors involving compdef & compinit such as command not found:
357-
```
358-
$ compdef:
359-
autoload -Uz compinit
360-
$ compinit
350+
source <(argocd completion zsh)
351+
compdef _argocd argocd
361352
```
362353
363354
##### Usage:
@@ -531,7 +522,6 @@ $ compinit
531522
eg:
532523
```
533524
# get the admin password and use it by enclosing in single quotes.
534-
# echo ${ADMIN_PASSWD}
535525
# argocd login --username admin --password '<password>' openshift-gitops.openshift-gitops.apps-crc.testing
536526
```
537527
**IMPORTANT** passwords can contain special characters like `$` which would be interpreted as shell variables. This can cause the command to fail as a wrong value (shell interpreted) of password would be sent to the server. Always use single quotes '' to enclose the actual value of the password to avoid such errors.
@@ -651,7 +641,6 @@ $ compinit
651641
eg:
652642
```
653643
# get the admin password and use it by enclosing in single quotes.
654-
# echo ${ADMIN_PASSWD}
655644
# argocd login --username admin --password '<password>' openshift-gitops.openshift-gitops.apps-crc.testing
656645
```
657646
**IMPORTANT** passwords can contain special characters like `$` which would be interpreted as shell variables. This can cause the command to fail as a wrong value (shell interpreted) of password would be sent to the server. Always use single quotes '' to enclose the actual value of the password to avoid such errors.
@@ -763,7 +752,6 @@ $ compinit
763752
eg:
764753
```
765754
# get the admin password and use it by enclosing in single quotes.
766-
# echo ${ADMIN_PASSWD}
767755
# argocd login --username admin --password '<password>' openshift-gitops.openshift-gitops.apps-crc.testing
768756
```
769757
**IMPORTANT** passwords can contain special characters like `$` which would be interpreted as shell variables. This can cause the command to fail as a wrong value (shell interpreted) of password would be sent to the server. Always use single quotes '' to enclose the actual value of the password to avoid such errors.

0 commit comments

Comments
 (0)