Skip to content

Commit a5acd00

Browse files
authored
Add Web Login to the Documentation (#2154)
1 parent 9845a7c commit a5acd00

File tree

4 files changed

+19
-11
lines changed

4 files changed

+19
-11
lines changed

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ jf rt u "(*).tgz" my-local-repo/{1}/ --recursive=false
140140

141141
Upload all files whose name begins with "frog" to folder **frogfiles** in the target repository, but append its name with the text "-up". For example, a file called **froggy.tgz** should be renamed **froggy.tgz-up**.
142142
```
143-
jf u "(frog*)" my-local-repo/frogfiles/{1}-up --recursive=false
143+
jf rt u "(frog*)" my-local-repo/frogfiles/{1}-up --recursive=false
144144
```
145145

146146
##### **Example 3: Upload all files to corresponding directories according to extension type**
@@ -235,8 +235,8 @@ This command is used to upload files to Artifactory.
235235
| --retry-wait-time | \[Default: 0s\]<br><br>Number of seconds or milliseconds to wait between retries. The numeric value should either end with s for seconds or ms for milliseconds. |
236236
| --detailed-summary | \[Default: false\]<br><br>Set to true to include a list of the affected files as part of the command output summary. |
237237
| --insecure-tls | \[Default: false\]<br><br>Set to true to skip TLS certificates verification. |
238-
| Command arguments | The command takes two arguments.<br><br>In case the --spec option is used, the commands accept no arguments. |
239-
| Source path | The first argument specifies the local file system path to artifacts that should be uploaded to Artifactory. You can specify multiple artifacts by using wildcards or a regular expression as designated by the **--regexp** command option. Please read the **--regexp** option description for more information. |
238+
| Command arguments | The command takes two arguments.<br><br>In case the --spec option is used, the commands accept no arguments. |
239+
| Source path | The first argument specifies the local file system path to artifacts that should be uploaded to Artifactory. You can specify multiple artifacts by using wildcards or a regular expression as designated by the **--regexp** command option. Please read the **--regexp** option description for more information. |
240240
| Target path | The second argument specifies the target path in Artifactory in the following format: `[repository name]/[repository path]`<br><br>If the target path ends with a slash, the path is assumed to be a folder. For example, if you specify the target as "repo-name/a/b/", then "b" is assumed to be a folder in Artifactory into which files should be uploaded. If there is no terminal slash, the target path is assumed to be a file to which the uploaded file should be renamed. For example, if you specify the target as "repo-name/a/b", the uploaded file is renamed to "b" in Artifactory.<br><br>For flexibility in specifying the upload path, you can include placeholders in the form of {1}, {2} which are replaced by corresponding tokens in the source path that are enclosed in parenthesis. For more details, please refer to [Using Placeholders](https://jfrog.com/help/r/jfrog-cli/using-placeholders). |
241241

242242
#### Examples

Diff for: documentation/JFrog-CLI.md

+16-8
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ JFrog CLI supports uploading files to Artifactory using wildcard patterns, regul
1818

1919
JFrog CLI offers comprehensive support for popular package managers and build tools. It seamlessly integrates with package managers like npm, Maven, NuGet, Docker and more, allowing you to easily manage and publish packages.
2020

21-
### Binaries and depedencies scanning
21+
### Binaries and dependencies scanning
2222

2323
JFrog CLI empowers you with robust scanning capabilities to ensure the security and compliance of your software artifacts, including containers. It integrates with JFrog Xray, enabling you to scan and analyze your projects and packages, including containers, for vulnerabilities, license compliance, and quality issues. With JFrog CLI, you can proactively identify and mitigate potential risks, ensuring the integrity and safety of your software supply chain.
2424

@@ -292,7 +292,7 @@ JFrog CLI makes use of the following environment variables:
292292
| | |
293293
|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
294294
| **Variable Name** | **Description** |
295-
| **JFROG_CLI_LOG_LEVEL** | \[Default: INFO\]<br><br>This variable determines the log level of the JFrog CLI. <br>Possible values are: DEBUG, INFO, WARN and ERROR. <br>If set to ERROR, JFrog CLI logs error messages only. It is useful when you wish to read or parse the JFrog CLI output and do not want any other information logged. |
295+
| **JFROG_CLI_LOG_LEVEL** | \[Default: INFO\]<br><br>This variable determines the log level of the JFrog CLI. <br>Possible values are: DEBUG, INFO, WARN and ERROR. <br>If set to ERROR, JFrog CLI logs error messages only. It is useful when you wish to read or parse the JFrog CLI output and do not want any other information logged. |
296296
| **JFROG_CLI_LOG_TIMESTAMP** | \[Default: TIME\]<br><br>Controls the log messages timestamp format. Possible values are: TIME, DATE\_AND\_TIME, and OFF. |
297297
| **JFROG_CLI_HOME_DIR** | \[Default: ~/.jfrog\]<br><br>Defines the JFrog CLI home directory. |
298298
| **JFROG_CLI_TEMP_DIR** | \[Default: The operating system's temp directory\]<br><br>Defines the temp directory used by JFrog CLI. |
@@ -304,9 +304,17 @@ JFrog CLI makes use of the following environment variables:
304304
305305
## JFrog Platform Configuration
306306
307+
### Web Login to the JFrog Platform
308+
309+
You can use the `jf login` command to authenticate with the JFrog Platform through the web browser.
310+
This command is solely interactive, meaning it does not receive any options and cannot be used in a CI server.
311+
312+
![login-page.png](images/login-page.png)
313+
![login-successful.png](images/login-successful.png)
314+
307315
### Adding and Editing Configured Servers
308316
309-
The **config add** and **config edit** commands are used to add and edit JFrog Platform server configuration, stored in JFrog CLI's configuration storage. These configured servers can be used by the other commands. The configured servers' details can be overridden per command by passing in alternative values for the URL and login credentials. The values configured are saved in file under the JFrog CLI home directory.
317+
The `jf config add` and `jf config edit` commands are used to add and edit JFrog Platform server configuration, stored in JFrog CLI's configuration storage. These configured servers can be used by the other commands. The configured servers' details can be overridden per command by passing in alternative values for the URL and login credentials. The values configured are saved in file under the JFrog CLI home directory.
310318
311319
| | |
312320
|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -329,13 +337,13 @@ The **config add** and **config edit** commands are used to add and edit JFrog P
329337
| --url | \[Optional\]<br><br>JFrog platform URL. |
330338
| --user | \[Optional\]<br><br>JFrog Platform username. |
331339
| --xray-url | \[Optional\] Xray URL. |
332-
| --overwrite | \[Available for _config add_ only\]<br><br>\[Default: false\]<br><br>Overwrites the instance configuration if an instance with the same ID already exists. |
340+
| --overwrite | \[Available for `jf config add` only\]<br><br>\[Default: false\]<br><br>Overwrites the instance configuration if an instance with the same ID already exists. |
333341
| Command arguments | |
334342
| server ID | A unique ID for the server configuration. |
335343
336344
### Removing Configured Servers
337345
338-
The _config remove_ command is used to remove JFrog Platform server configuration, stored in JFrog CLI's configuration storage.
346+
The `jf config remove` command is used to remove JFrog Platform server configuration, stored in JFrog CLI's configuration storage.
339347
340348
| | |
341349
|-------------------|--------------------------------------------------------------------------------------|
@@ -348,7 +356,7 @@ The _config remove_ command is used to remove JFrog Platform server configuratio
348356
349357
### Showing the Configured Servers
350358
351-
The _config show_ command shows the stored configuration. You may show a specific server's configuration by sending its ID as an argument to the command.
359+
The `jf config show` command shows the stored configuration. You may show a specific server's configuration by sending its ID as an argument to the command.
352360
353361
| | |
354362
|-------------------|-----------------------------------------------------------------------------------------|
@@ -359,7 +367,7 @@ The _config show_ command shows the stored configuration. You may show a specifi
359367
360368
### Setting a Server as Default
361369
362-
The _config use_ command sets a configured server as default. The following commands will use this server.
370+
The `jf config use` command sets a configured server as default. The following commands will use this server.
363371
364372
| | |
365373
|-------------------|-----------------------------------------|
@@ -369,7 +377,7 @@ The _config use_ command sets a configured server as default. The following comm
369377
370378
### Exporting and Importing Configuration
371379
372-
The _config export_ command generates a token, which stores the server configuration. This token can be used by the _config import_ command, to import the configuration stored in the token, and save it in JFrog CLI's configuration storage.
380+
The `jf config export` command generates a token, which stores the server configuration. This token can be used by the `jf config import` command, to import the configuration stored in the token, and save it in JFrog CLI's configuration storage.
373381
374382
#### Export
375383

Diff for: documentation/images/login-page.png

176 KB
Loading

Diff for: documentation/images/login-successful.png

175 KB
Loading

0 commit comments

Comments
 (0)