Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix docs #2138

Closed
wants to merge 2 commits into from
Closed

Fix docs #2138

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dafe589
Fix docs
sverdlov93 Aug 16, 2023
f8d57c9
Fix docs
sverdlov93 Aug 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,8 +243,8 @@

# Overview

JFrog CLI is a compact and smart client that provides a simple interface that automates access to _Artifactory_ and
_Mission Control_ through their respective REST APIs.
JFrog CLI is a compact and smart client that provides a simple interface that automates access to **Artifactory** and
**Mission Control** through their respective REST APIs.
By using the JFrog CLI, you can greatly simplify your automation scripts making them more readable and easier to
maintain.
Several features of the JFrog CLI makes your scripts more efficient and reliable:
Expand Down
2 changes: 1 addition & 1 deletion artifactory/cli.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -995,7 +995,7 @@ func getRetryWaitTime(c *cli.Context) (waitMilliSecs int, err error) {
}

func getRetryWaitTimeVerificationError() error {
return errorutils.CheckError(errors.New("The '--retry-wait-time' option should have a numeric value with 's'/'ms' suffix. " + cliutils.GetDocumentationMessage()))
return errorutils.CheckErrorf("The '--retry-wait-time' option should have a numeric value with 's'/'ms' suffix. " + cliutils.GetDocumentationMessage())
}

func dockerPromoteCmd(c *cli.Context) error {
Expand Down
4 changes: 2 additions & 2 deletions buildtools/cli.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -842,7 +842,7 @@ func GetNpmConfigAndArgs(c *cli.Context) (configFilePath string, args []string,
}

if !exists {
return "", nil, errorutils.CheckError(errors.New("no config file was found! Before running the npm command on a project for the first time, the project should be configured using the npm-config command"))
return "", nil, errorutils.CheckErrorf("no config file was found! Before running the npm command on a project for the first time, the project should be configured using the npm-config command")
}
_, args = getCommandName(c.Args())
return
Expand Down Expand Up @@ -914,7 +914,7 @@ func terraformCmd(c *cli.Context) error {
case "publish", "p":
return terraformPublishCmd(configFilePath, filteredArgs, c)
default:
return errorutils.CheckError(errors.New("Terraform command:\"" + cmdName + "\" is not supported. " + cliutils.GetDocumentationMessage()))
return errorutils.CheckErrorf("Terraform command:\"" + cmdName + "\" is not supported. " + cliutils.GetDocumentationMessage())
}
}

Expand Down
14 changes: 9 additions & 5 deletions documentation/CLI-for-JFrog-Artifactory.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,9 @@ Any wildcard enclosed in parentheses in the source path can be matched with a co

##### **Example 1: Upload all files to the target repository**

For each .tgz file in the source directory, create a corresponding directory with the same name in the target repository and upload it there. For example, a file named **froggy.tgz** should be uploaded to **my-local-rep/froggy**. **froggy** will be created in a folder in Artifactory).
For each .tgz file in the source directory, create a corresponding directory with the same name in the target repository
and upload it there. For example, a file named **froggy.tgz** should be uploaded to **my-local-rep/froggy**. **froggy**
will be created in a folder in Artifactory.
```
jf rt u "(*).tgz" my-local-repo/{1}/ --recursive=false
```
Expand Down Expand Up @@ -235,8 +237,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 Expand Up @@ -2869,7 +2871,9 @@ If you're using JFrog CLI on a machine which has no access to the internet, you

1. Create a remote Maven repository in Artifactory and name it **extractors**. When creating the repository, configure it to proxy [https://releases.jfrog.io/artifactory/oss-release-local](https://releases.jfrog.io/artifactory/oss-release-local)
2. Make sure that this Artifactory server is known to JFrog CLI, using the [jfrog c show](https://jfrog.com/help/r/jfrog-cli/showing-the-configured-servers) command. If not, configure it using the [jfrog c add](https://jfrog.com/help/r/jfrog-cli/Adding-and-Editing-Configured-Servers) command.
3. Set the **JFROG_CLI_EXTRACTORS_REMOTE** environment variable with the server ID of the Artifactory server you configured, followed by a slash, and then the name of the repository you created. For example **_my-rt-server/extractors_**
3. Set the **JFROG_CLI_EXTRACTORS_REMOTE** environment variable with the server ID of the Artifactory server you
configured, followed by a slash, and then the name of the repository you created. For example *
*my-rt-server/extractors**

## Transferring Files Between Artifactory Servers

Expand Down Expand Up @@ -2992,7 +2996,7 @@ The `jf rt transfer-files` command pushes the files from the source instance to

**Using Replication**
> To help reduce the time it takes for Phase 2 to run, you may configure Event Based Push Replication for some or all of the local repositories on the source instance. With Replication configured, when files are created or updated on the source repository, they are immediately replicated to the corresponding repository on the target instance.
The replication can be configured at any time. Before, during or after the files transfer process.
> The replication can be configured at any time. Before, during or after the files transfer process.
---

### Files Transfer State
Expand Down
Loading
Loading