Skip to content

Commit bc33ae0

Browse files
authored
CM-28389 - Update "cycode configure" section in README (#174)
1 parent 4549b2b commit bc33ae0

File tree

1 file changed

+22
-10
lines changed

1 file changed

+22
-10
lines changed

README.md

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -119,38 +119,50 @@ To install the Cycode CLI application on your local machine, perform the followi
119119
### Using the Configure Command
120120

121121
> :memo: **Note**<br/>
122-
> If you already set up your Cycode client ID and client secret through the Linux or Windows environment variables, those credentials will take precedent over this method.
122+
> If you already set up your Cycode Client ID and Client Secret through the Linux or Windows environment variables, those credentials will take precedent over this method.
123123
124124
1. Type the following command into your terminal/command line window:
125125

126126
`cycode configure`
127127

128-
You will see the following appear:
128+
2. Enter your Cycode API URL value (you can leave blank to use default value).
129129

130130
```bash
131-
Update credentials in file (/Users/travislloyd/.cycode/credentials.yaml)
132-
cycode client id []:
131+
Cycode API URL [https://api.cycode.com]: https://api.onpremise.com
133132
```
134133

135-
2. Enter your Cycode client ID value.
134+
3. Enter your Cycode APP URL value (you can leave blank to use default value).
136135

137136
```bash
138-
cycode client id []: 7fe5346b-xxxx-xxxx-xxxx-55157625c72d
137+
Cycode APP URL [https://app.cycode.com]: https://app.onpremise.com
139138
```
140139

141-
3. Enter your Cycode client secret value.
140+
4. Enter your Cycode Client ID value.
142141

143142
```bash
144-
cycode client secret []: c1e24929-xxxx-xxxx-xxxx-8b08c1839a2e
143+
Cycode Client ID []: 7fe5346b-xxxx-xxxx-xxxx-55157625c72d
145144
```
146145

147-
4. If the values were entered successfully, you'll see the following message:
146+
5. Enter your Cycode Client Secret value.
147+
148+
```bash
149+
Cycode Client Secret []: c1e24929-xxxx-xxxx-xxxx-8b08c1839a2e
150+
```
151+
152+
6. If the values were entered successfully, you'll see the following message:
148153
149154
```bash
150155
Successfully configured CLI credentials!
151156
```
152157
153-
If you go into the `.cycode` folder under your user folder, you'll find these credentials were created and placed in the `credentials.yaml` file in that folder.
158+
or/and
159+
160+
```bash
161+
Successfully configured Cycode URLs!
162+
```
163+
164+
If you go into the `.cycode` folder under your user folder, you'll find these credentials were created and placed in the `credentials.yaml` file in that folder.
165+
And the URLs were placed in the `config.yaml` file in that folder.
154166

155167
### Add to Environment Variables
156168

0 commit comments

Comments
 (0)