You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/OpenShift GitOps CLI User Guide.md
+65-17Lines changed: 65 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -117,21 +117,67 @@ argocd: v2.9.2+c5ea5c4
117
117
```
118
118
**Note:** The above output is just for reference. The actual details might be different based on the version of OpenShift GitOps argocd CLI client installed.
119
119
120
+
## Configuring OpenShift GitOps CLI (argocd)
121
+
122
+
Configure the Red Hat OpenShift GitOps `argocd` CLI to enable tab completion.
123
+
124
+
### Enabling tab completion
125
+
126
+
After you install the `argocd` CLI, you can enable tab completion to automatically complete `argocd` commands or suggest options when you press Tab.
127
+
128
+
#### Prerequisites
129
+
- You must have the `argocd` CLI tool installed.
130
+
- You must have bash-completion installed on your local system.
131
+
132
+
#### Procedure
133
+
The following procedure enables tab completion for Bash.
Alternatively, you can save the file to a local directory and source it from your `.bashrc` file instead.
144
+
145
+
Tab completion is enabled when you open a new terminal.
146
+
120
147
## OpenShift GitOps argocd reference
148
+
121
149
This section lists the basic `argocd` CLI commands.
122
150
**Note** MicroShift based installation do not host an ArgoCD server and supports only the `core` mode of execution.
123
151
In the `core` mode (`--core` argument specified), the CLI talks directly to the Kubernetes API server set as per the `KUBECONFIG` environment variable or the default file `$HOME/.kube/config`. There is no need for users to login into the ArgoCD server for executing commands.
124
152
125
153
### Basic syntax
126
-
- Normal mode
127
-
```
128
-
argocd [command or options][arguments…]
129
-
```
130
154
131
-
- Core mode
155
+
#### Normal mode
156
+
157
+
In the normal mode, users have to login to the ArgoCD server component using the login component before executing the commands.
In the `core` mode (`--core` argument specified), the CLI talks directly to the Kubernetes API server set as per the `KUBECONFIG` environment variable or the default file `$HOME/.kube/config`. There is no need for users to login into the ArgoCD server for executing commands.
132
177
```
133
178
KUBECONFIG=~/.kube/config argocd --core [command or options][arguments…]
134
179
```
180
+
135
181
### Global options
136
182
137
183
| Option| Argument Type | Description|
@@ -158,7 +204,7 @@ In the `core` mode (`--core` argument specified), the CLI talks directly to the
158
204
| --redis-name | string | Name of the Redis deployment; set this or the ARGOCD_REDIS_NAME environment variable when the Redis's name label differs from the default, for example when installing via the Helm chart (default "argocd-redis") |
159
205
160
206
161
-
### Global Commands
207
+
### Utility Commands
162
208
163
209
#### version
164
210
Print version information
@@ -236,16 +282,12 @@ compinit
236
282
###### Flags:
237
283
-h, --help help for completion
238
284
239
-
### Login Commands
285
+
### Login related Commands
240
286
* [argocd login](./cli/argocd_login.md) - Log in to an Argo CD server
241
287
* [argocd logout](./cli/argocd_logout.md) - Log out from Argo CD
242
288
* [argocd relogin](./cli/argocd_relogin.md) - Refresh an expired authenticate token
243
-
* [argocd gpg add](./cli/argocd_gpg_add.md) - Adds a GPG public key to the server's keyring
244
-
* [argocd gpg get](./cli/argocd_gpg_get.md) - Get the GPG public key with ID <KEYID> from the server
245
-
* [argocd gpg list](./cli/argocd_gpg_list.md) - List configured GPG public keys
246
-
* [argocd gpg rm](./cli/argocd_gpg_rm.md) - Removes a GPG public key from the server's keyring
247
289
248
-
### Admin Commands
290
+
### Administrative Commands
249
291
* [argocd admin](./cli/argocd_admin.md) - Contains a set of commands useful for Argo CD administrators and requires direct Kubernetes access
250
292
* [argocd admin export](./cli/argocd_admin_export.md) - Export all Argo CD data to stdout (default) or a file
251
293
* [argocd admin import](./cli/argocd_admin_import.md) - Import Argo CD data from stdin (specify `-') or a file
0 commit comments