Skip to content

Commit 5c9b9e8

Browse files
committed
updated Readme
1 parent 3a82eb6 commit 5c9b9e8

File tree

1 file changed

+37
-1
lines changed

1 file changed

+37
-1
lines changed

README.md

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,30 @@ The binary is built on using `ubuntu-latest`. You can find what is included in
2323

2424
## Usage
2525

26+
### Main Help
27+
28+
```shell
29+
Usage: cf-support
30+
Version: vX.X.X
31+
32+
Description:
33+
34+
Tool to gather information for Codefresh Support
35+
36+
Options:
37+
38+
-h, --help - Show this help.
39+
-V, --version - Show the version number for this program.
40+
41+
Commands:
42+
43+
gitops - Collect data for the Codefresh GitOps Runtime
44+
pipelines - Collect data for the Codefresh Pipelines Runtime
45+
onprem - Collect data for the Codefresh OnPrem Installation
46+
oss - Collect data for the Open Source ArgoCD
47+
48+
```
49+
2650
### macOS - arm64
2751

2852
```shell
@@ -90,8 +114,20 @@ chmod +x cf-support
90114
### Windows - amd6
91115

92116
1. Go the the [Latest](https://github.com/codefresh-io/codefresh-support-package/releases/latest) release.
93-
1. Download the cf-support_windows_amd64.zip file
117+
1. Download the cf-support_windows_amd64.zip file and extract the `.exe`
94118
1. Run the `.exe` file via CMD or PowerShell
119+
- Do not use the ISE version of PowerShell
120+
121+
```powershell
122+
# CMD
123+
C:\Users\Administrator\Downloads>cf-support_windows_amd64.exe
124+
```
125+
126+
```powershell
127+
# PowerShell
128+
129+
PS C:\Users\Administrator\Downloads> .\cf-support_windows_amd64.exe
130+
```
95131

96132
## How to Release a New Version
97133

0 commit comments

Comments
 (0)