Skip to content

Commit 0d5af6f

Browse files
committed
Docs fixes for Xray
1 parent 9628841 commit 0d5af6f

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

Diff for: documentation/CLI-for-JFrog-Xray.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ When used with Xray, JFrog CLI offers several means of authentication: JFrog CLI
1414

1515
#### Authenticating with Username and Password
1616

17-
To authenticate yourself using your Xray login credentials, either configure your credentials once using the_jfrog c add_ command or provide the following option to each command.
17+
To authenticate yourself using your Xray login credentials, either configure your credentials once using the_jf c add_ command or provide the following option to each command.
1818

1919
| | |
2020
| --- | --- |
@@ -25,7 +25,7 @@ To authenticate yourself using your Xray login credentials, either configure you
2525

2626
#### Authenticating with an Access Token
2727

28-
To authenticate yourself using an Xray Access Token, either configure your Access Token once using the _jfrog c add_command or provide the following option to each command.
28+
To authenticate yourself using an Xray Access Token, either configure your Access Token once using the _jf c add_command or provide the following option to each command.
2929

3030
| | |
3131
| --- | --- |
@@ -48,7 +48,7 @@ Execute a cUrl command, using the configured Xray details. The command expects t
4848
| Command name | xr curl |
4949
| Abbreviation | xr cl |
5050
| Command options | |
51-
| --server-id | \[Optional\]<br><br>Server ID configured using the _jfrog c add_ command. If not specified, the default configured server is used. |
51+
| --server-id | \[Optional\]<br><br>Server ID configured using the _jf c add_ command. If not specified, the default configured server is used. |
5252
| Command arguments | |
5353
| cUrl arguments and flags | The same list of arguments and flags passed to cUrl, except for the following changes:<br><br>1. The full Xray URL should not be passed. Instead, the REST endpoint URI should be sent.<br>2. The login credentials should not be passed. Instead, the --server-id should be used. |
5454

@@ -110,7 +110,7 @@ This **jf scan**_ command scans files on the local file-system with Xray. 
110110
| **Command name** | scan |
111111
| **Abbreviation** | s |
112112
| **Command options** | |
113-
| --server-id | \[Optional\]<br><br>Server ID configured using the _jfrog c add_ command. If not specified, the default configured server is used. |
113+
| --server-id | \[Optional\]<br><br>Server ID configured using the _jf c add_ command. If not specified, the default configured server is used. |
114114
| --spec | \[Optional\]<br><br>Path to a file specifying the files to scan. If the pattern argument is provided to the command, this option should not be provided. |
115115
| --project | \[Optional\]<br><br>JFrog project key, to enable Xray to determine security violations accordingly. The command accepts this option only if the --repo-path and --watches options are not provided. If none of the three options are provided, the command will show all known vulnerabilities. |
116116
| --repo-path | \[Optional\]<br><br>Artifactory repository path in the form of &lt;repository&gt;/&lt;path in the repository&gt;, to enable Xray to determine violations accordingly. The command accepts this option only if the --project and --watches options are not provided. If none of the three options are provided, the command will show all known vulnerabilities. |
@@ -188,7 +188,7 @@ This j_**f docker scan**_ command scans docker containers located on the local f
188188
| **Command name** | docker scan |
189189
| **Abbreviation** | |
190190
| **Command options** | |
191-
| --server-id | \[Optional\]<br><br>Server ID configured using the _jfrog c add_ command. If not specified, the default configured server is used. |
191+
| --server-id | \[Optional\]<br><br>Server ID configured using the _jf c add_ command. If not specified, the default configured server is used. |
192192
| --project | \[Optional\]<br><br>JFrog project key, to enable Xray to determine security violations accordingly. The command accepts this option only if the --repo-path and --watches options are not provided. If none of the three options are provided, the command will show all known vulnerabilities. |
193193
| --repo-path | \[Optional\]<br><br>Artifactory repository path in the form of &lt;repository&gt;/&lt;path in the repository&gt;, to enable Xray to determine violations accordingly. The command accepts this option only if the --project and --watches options are not provided. If none of the three options are provided, the command will show all known vulnerabilities. |
194194
| --watches | \[Optional\]<br><br>A comma separated list of Xray watches, to enable Xray to determine violations accordingly. The command accepts this option only if the --repo-path and --repo-path options are not provided. If none of the three options are provided, the command will show all known vulnerabilities. |
@@ -379,7 +379,7 @@ The command will detect the package manager used by the project automatically. I
379379
| **Command name** | audit |
380380
| **Abbreviation** | aud |
381381
| **Command options** | |
382-
| --server-id | \[Optional\]<br><br>Server ID configured using the _jfrog c add_ command. If not specified, the default configured server is used. |
382+
| --server-id | \[Optional\]<br><br>Server ID configured using the _jf c add_ command. If not specified, the default configured server is used. |
383383
| --project | \[Optional\]<br><br>JFrog project key, to enable Xray to determine security violations accordingly. The command accepts this option only if the --repo-path and --watches options are not provided. If none of the three options are provided, the command will show all known vulnerabilities |
384384
| --repo-path | \[Optional\]<br><br>Artifactory repository path in the form of &lt;repository&gt;/&lt;path in the repository&gt;, to enable Xray to determine violations accordingly. The command accepts this option only if the --project and --watches options are not provided. If none of the three options are provided, the command will show all known vulnerabilities |
385385
| --watches | \[Optional\]<br><br>A comma separated list of Xray watches, to enable Xray to determine violations accordingly. The command accepts this option only if the --repo-path and --repo-path options are not provided. If none of the three options are provided, the command will show all known vulnerabilities |
@@ -411,13 +411,13 @@ The command will detect the package manager used by the project automatically. I
411411

412412
Audit the project at the current directory. Show all known vulnerabilities, regardless of the policies defined in Xray.
413413

414-
jfrog audit
414+
jf audit
415415

416416
**Example 2**
417417

418418
Audit the project at the current directory. Show all known vulnerabilities, regardless of the policies defined in Xray. Show only maven and npm vulnerabilities 
419419

420-
jfrog audit --mvn --npm
420+
jf audit --mvn --npm
421421

422422
**Example 3**
423423

@@ -453,7 +453,7 @@ JFrog CLI is integrated with JFrog Xray and JFrog Artifactory, allowing you to h
453453
| Command name | build-scan |
454454
| Abbreviation | bs |
455455
| Command options | |
456-
| --server-id | \[Optional\]<br><br>Server ID configured by the _jfrog c add_ command. If not specified, the default configured server is used. |
456+
| --server-id | \[Optional\]<br><br>Server ID configured by the _jf c add_ command. If not specified, the default configured server is used. |
457457
| --vuln | \[Optional\]<br><br>Set if you'd like to receive all vulnerabilities, regardless of the policy configured in Xray. |
458458
| --fail | \[Default: true\]<br><br>When set, the command returns exit code 3 if a 'Fail Build' rule is matched by Xray. <br>Set to false if you do not wish the command to return exit code 3 in such case, and an exit code 0 will be returned. |
459459
| --format | \[Default: table\]<br><br>Defines the output format of the command. The accepted values are: **_table_** and _**json**_. |

0 commit comments

Comments
 (0)