Skip to content

Commit

Permalink
Add Web Login to the Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@RobiNino
RobiNino committed Aug 24, 2023
1 parent 9845a7c commit 767b742
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 11 deletions.
6 changes: 3 additions & 3 deletions documentation/CLI-for-JFrog-Artifactory.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ jf rt u "(*).tgz" my-local-repo/{1}/ --recursive=false

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**.
```
jf u "(frog*)" my-local-repo/frogfiles/{1}-up --recursive=false
jf rt u "(frog*)" my-local-repo/frogfiles/{1}-up --recursive=false
```

##### **Example 3: Upload all files to corresponding directories according to extension type**
Expand Down Expand Up @@ -235,8 +235,8 @@ This command is used to upload files to Artifactory.
| --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. |
| --detailed-summary | \[Default: false\]<br><br>Set to true to include a list of the affected files as part of the command output summary. |
| --insecure-tls | \[Default: false\]<br><br>Set to true to skip TLS certificates verification. |
| Command arguments | The command takes two arguments.<br><br>In case the --spec option is used, the commands accept no arguments. |
| 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. |
| Command arguments | The command takes two arguments.<br><br>In case the --spec option is used, the commands accept no arguments. |
| 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. |
| 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). |

#### Examples
Expand Down
22 changes: 14 additions & 8 deletions documentation/JFrog-CLI.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ JFrog CLI supports uploading files to Artifactory using wildcard patterns, regul

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.

### Binaries and depedencies scanning
### Binaries and dependencies scanning

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.

Expand Down Expand Up @@ -292,7 +292,7 @@ JFrog CLI makes use of the following environment variables:
| | |
|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Variable Name** | **Description** |
| **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. |
| **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. |
| **JFROG_CLI_LOG_TIMESTAMP** | \[Default: TIME\]<br><br>Controls the log messages timestamp format. Possible values are: TIME, DATE\_AND\_TIME, and OFF. |
| **JFROG_CLI_HOME_DIR** | \[Default: ~/.jfrog\]<br><br>Defines the JFrog CLI home directory. |
| **JFROG_CLI_TEMP_DIR** | \[Default: The operating system's temp directory\]<br><br>Defines the temp directory used by JFrog CLI. |
Expand All @@ -306,7 +306,7 @@ JFrog CLI makes use of the following environment variables:
### Adding and Editing Configured Servers
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.
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.
| | |
|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
Expand All @@ -329,13 +329,19 @@ The **config add** and **config edit** commands are used to add and edit JFrog P
| --url | \[Optional\]<br><br>JFrog platform URL. |
| --user | \[Optional\]<br><br>JFrog Platform username. |
| --xray-url | \[Optional\] Xray URL. |
| --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. |
| --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. |
| Command arguments | |
| server ID | A unique ID for the server configuration. |
### Configuring using Web Login
The `login` command is used to add a JFrog Platform server configuration, by logging in to the platform via your web browser.
This command is solely interactive, meaning it does not receive any options and cannot be used in a CI server.
### Removing Configured Servers
The _config remove_ command is used to remove JFrog Platform server configuration, stored in JFrog CLI's configuration storage.
The `config remove` command is used to remove JFrog Platform server configuration, stored in JFrog CLI's configuration storage.
| | |
|-------------------|--------------------------------------------------------------------------------------|
Expand All @@ -348,7 +354,7 @@ The _config remove_ command is used to remove JFrog Platform server configuratio
### Showing the Configured Servers
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.
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.
| | |
|-------------------|-----------------------------------------------------------------------------------------|
Expand All @@ -359,7 +365,7 @@ The _config show_ command shows the stored configuration. You may show a specifi
### Setting a Server as Default
The _config use_ command sets a configured server as default. The following commands will use this server.
The `config use` command sets a configured server as default. The following commands will use this server.
| | |
|-------------------|-----------------------------------------|
Expand All @@ -369,7 +375,7 @@ The _config use_ command sets a configured server as default. The following comm
### Exporting and Importing Configuration
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.
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.
#### Export
Expand Down

0 comments on commit 767b742

Please sign in to comment.