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: documentation/CLI-for-JFrog-Xray.md
+9-9
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ When used with Xray, JFrog CLI offers several means of authentication: JFrog CLI
14
14
15
15
#### Authenticating with Username and Password
16
16
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.
18
18
19
19
|||
20
20
| --- | --- |
@@ -25,7 +25,7 @@ To authenticate yourself using your Xray login credentials, either configure you
25
25
26
26
#### Authenticating with an Access Token
27
27
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.
29
29
30
30
|||
31
31
| --- | --- |
@@ -48,7 +48,7 @@ Execute a cUrl command, using the configured Xray details. The command expects t
48
48
| Command name | xr curl |
49
49
| Abbreviation | xr cl |
50
50
| 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. |
52
52
| Command arguments ||
53
53
| 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. |
54
54
@@ -110,7 +110,7 @@ This **jf scan**_ command scans files on the local file-system with Xray.
110
110
|**Command name**| scan |
111
111
|**Abbreviation**| s |
112
112
|**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. |
114
114
| --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. |
115
115
| --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. |
116
116
| --repo-path |\[Optional\]<br><br>Artifactory repository path in the form of <repository>/<path in the repository>, 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
188
188
|**Command name**| docker scan |
189
189
|**Abbreviation**||
190
190
|**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. |
192
192
| --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. |
193
193
| --repo-path |\[Optional\]<br><br>Artifactory repository path in the form of <repository>/<path in the repository>, 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. |
194
194
| --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
379
379
|**Command name**| audit |
380
380
|**Abbreviation**| aud |
381
381
|**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. |
383
383
| --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 |
384
384
| --repo-path |\[Optional\]<br><br>Artifactory repository path in the form of <repository>/<path in the repository>, 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 |
385
385
| --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
411
411
412
412
Audit the project at the current directory. Show all known vulnerabilities, regardless of the policies defined in Xray.
413
413
414
-
jfrog audit
414
+
jf audit
415
415
416
416
**Example 2**
417
417
418
418
Audit the project at the current directory. Show all known vulnerabilities, regardless of the policies defined in Xray. Show only maven and npm vulnerabilities
419
419
420
-
jfrog audit --mvn --npm
420
+
jf audit --mvn --npm
421
421
422
422
**Example 3**
423
423
@@ -453,7 +453,7 @@ JFrog CLI is integrated with JFrog Xray and JFrog Artifactory, allowing you to h
453
453
| Command name | build-scan |
454
454
| Abbreviation | bs |
455
455
| 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. |
457
457
| --vuln |\[Optional\]<br><br>Set if you'd like to receive all vulnerabilities, regardless of the policy configured in Xray. |
458
458
| --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. |
459
459
| --format |\[Default: table\]<br><br>Defines the output format of the command. The accepted values are: **_table_** and _**json**_. |
0 commit comments