Need help with other JFrog products?
JFrog Platform
JFrog Artifactory
JFrog Xray
JFrog Mission Control
JFrog Distribution
[JFrog Pipelines]
JFrog Access
Skip to end of metadata
Go to start of metadata
Storing Symlinks in Artifactory
Storing Symlinks in Artifactory
JFrog CLI lets you upload and download artifacts from your local file-system to Artifactory, this also includes uploading symlinks (soft links).
Symlinks are stored in Artifactory as files with a zero size, with the following properties:
symlink.dest- The actual path on the original filesystem to which the symlink points
symlink.destsha1- the SHA1 checksum of the value in thesymlink.destproperty
To upload symlinks, the上传commandshould be executed with the--symlinksoption set to true.
When downloading symlinks stored in Artifactory, the CLI can verify that the file to which the symlink points actually exists and that it has the correct SHA1 checksum. To add this validation, you should use the--validate-symlinksoption with thedownload command。
Using Placeholders
The JFrog CLI offers enormous flexibility in how youdownload, upload,copy, ormovefiles through use of wildcard or regular expressions with placeholders.
Any wildcard enclosed in parenthesis in the source path can be matched with a corresponding placeholder in the target path to determine the name of the artifact once uploaded.
Examples
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 namedfroggy.tgzshould be uploaded tomy-local-rep/froggy。(froggywill be created a folder in Artifactory).
$ jf rt u "(*).tgz" my-local-repo/{1}/ --recursive=false
Example 2: Upload all files sharing the same prefix to the target repository
Upload all files whose name begins with "frog" to folderfrogfilesin the target repository, but append its name with the text "-up". For example, a file calledfroggy.tgzshould be renamedfroggy.tgz-up.
$ jf u "(frog*)" my-local-repo/frogfiles/{1}-up --recursive=false
Example 3: Upload all files to corresponding directories according to extension type
Upload all files in the current directory to themy-local-reporepository and place them in directories which match their file extensions.
$ jf rt u "(*).(*)" my-local-repo/{2}/{1}.{2} --recursive=false
Example 4: Copy all zip files to target respository and append with an extension.
Copy all zip files under /rabbit in thesource-frog-reporepository into the same path in thetarget-frog-reporepository and append the copied files' names with ".cp".
jf rt cp "source-frog-repo/rabbit/(*.zip)" target-frog-repo/rabbit/{1}.cp
General Commands
The following sections describe the commands available in the JFrog CLI for use with Artifactory.
Verifying Artifactory is Accessible
This command can be used to verify that Artifactory is accessible by sending an applicative ping to Artifactory.
Command name |
rt ping |
Abbreviation |
rt p |
Command options |
|
| --url | [Optional] Artifactory URL. |
| --server-id | [Optional] Server ID configured using thejfrog c add命令。If not specified, the default configured Artifactory server is used. |
| --insecure-tls | [Default: false] Set to true to skip TLS certificates verification. |
Command arguments |
The command accepts no arguments. |
Examples
Example 1
Ping the configured default Artifactory server.
$ jf rt ping
Example 2
Ping the configured Artifactory server with IDrt-server-1。
$ jf rt ping --server-id=rt-server-1
Example 3
Ping the Artifactory server. accessible though the specified URL.
$ jf rt ping --url=http://my-rt-server.com/artifactory
Uploading Files
This command is used to upload files to Artifactory.
Command name |
rt upload |
Abbreviation |
rt u |
Command options |
When using the * or ; characters in the upload command options or arguments, make sure to wrap the whole options or arguments string in quotes (") to make sure the * or ; characters are not interpreted as literals. |
| --archive | [Optional] Set to "zip" to pack and deploy the files to Artifactory inside a ZIP archive. Currently, the only packaging format supported is zip. |
--server-id |
[Optional] Server ID configured using thejfrog c add命令。If not specified, the default configured Artifactory server is used. |
| --spec | [Optional] Path to a file spec. For more details, please refer toUsing File Specs。 |
| --spec-vars | [Optional] 列表of variables in the form of "key1=value1;key2=value2;..." to be replaced in the File Spec. In the File Spec, the variables should be used as follows: ${key1}. |
| --build-name | [Optional] Build name. For more details, please refer toBuild Integration。 |
| --build-number | [Optional] Build number. For more details, please refer toBuild Integration。 |
| --project | [Optional] JFrog project key. |
| --module | [Optional] Optional module name for the build-info. |
| --target-props |
[Optional] A list of Artifactorypropertiesspecified as "key=value" pairs separated by a semi-colon ( ; ) to be attached to the uploaded files. If any key can take several values, then each value is separated by a comma ( , ). For example, "key1=value1;key2=value21,value22;key3=value3". |
| ——黛比 | [Optional] Used for Debian packages only. Specifies the distribution/component/architecture of the package. If the the value for distribution, component or architecture include a slash. the slash should be escaped with a back-slash. |
| --flat |
[Default: false] If true, files are uploaded to the exact target path specified and their hierarchy in the source file system is ignored. If false, files are uploaded to the target path while maintaining their file system hierarchy. Ifplaceholdersare used, the value of this option is ignored. JFrog CLI v1 在JFrog CLI v1, the default value of the --flat option is true. |
| --recursive | [Default: true] If true, files are also collected from sub-folders of the source directory for upload . If false, only files specifically in the source directory are uploaded. |
| --regexp | [Default: false] If true, the command will interpret the first argument, which describes the local file-system path of artifacts to upload, as a regular expression. If false, it will interpret the first argument as a wild-card expression. The above also applies for the --exclusions option. If you have specified that you are using regular expressions, then the beginning of the expression must be enclosed in parenthesis. For example:a/b/c/(.*)/file.zip |
| --ant | [Default: false] If true, the command will interpret the first argument, which describes the local file-system path of artifacts to upload, as an ANT pattern. If false, it will interpret the first argument as a wildcards expression. The above also applies for the --exclusions option. |
| --threads | [Default: 3] The number of parallel threads that should be used to upload where each thread uploads a single artifact at a time. |
| --dry-run | [Default: false] If true, the command only indicates which artifacts would have been uploaded If false, the command is fully executed and uploads artifacts as specified |
| --symlinks | [Default: false] If true, the command will preserve the soft links structure in Artifactory. Thesymlinkfile representation will contain the symbolic link and checksum properties. |
| --explode | [Default: false] If true, the command will extract an archive containing multiple artifacts after it is deployed to Artifactory, while maintaining the archive's file structure. |
| --include-dirs | [Default: false] If true, the source path applies to bottom-chain directories and not only to files. Botton-chain directories are either empty or do not include other directories that match the source path. |
| --exclusions | [Optional] A list of Semicolon-separated exclude patterns. Allows using wildcards, regular expressions or ANT patterns, according to the value of the--regexpand--antoptions. Please read the--regexpand--antoptions description for more information. |
| --sync-deletes | [Optional] Specific path in Artifactory, under which to sync artifacts after the upload. After the upload, this path will include only the artifacts uploaded during this upload operation. The other files under this path will be deleted. |
| --quiet | [Default: false] If true, the delete confirmation message is skipped. |
--fail-no-op |
[Default: false] Set to true if you'd like the command to return exit code 2 in case of no files are affected. |
| --retries | [Default: 3] Number of upload retries. |
| --retry-wait-time | [Default: 0s] 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] Set to true to include a list of the affected files as part of the command output summary. |
| --insecure-tls | [Default: false] Set to true to skip TLS certificates verification. |
Command arguments |
The command takes two arguments. 在case the --spec option is used, the commands accepts no arguments. |
| Source path |
The first argument specifies the local file system path to artifacts which should be uploaded to Artifactory. You can specify multiple artifacts by using wildcards or a regular expression as designated by the |
| Target path | The second argument specifies the target path in Artifactory in the following format: 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. 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 toUsing Placeholders。 |
Examples
Example 1
Upload a file calledfroggy.tgzto the root of themy-local-reporepository.
$ jf rt u froggy.tgz my-local-repo
Example 2
Collect all the zip files located under thebuilddirectory (including sub-directories), and upload them to themy-local-reporepository, under thezipFilesfolder, while maintaining the original names of the files.
$ jf rt u "build/*.zip" my-local-repo/zipFiles/
Example 3
Collect all the zip files located under thebuilddirectory (including sub-directories), and upload them to themy-local-reporepository, under thezipFilesfolder, while maintaining the original names of the files. Also delete all files in themy-local-reporepository, under thezipFilesfolder, except for the files which were uploaded by this command.
$ jf rt u "build/*.zip" my-local-repo/zipFiles/ --sync-deletes="my-local-repo/zipFiles/"
Example 4
Collect all files located under thebuilddirectory (including sub-directories), and upload them to themy-release-localrepository, under thefilesfolder, while maintaining the original names of the artifacts. Exclude (do not upload) files, which includeinstallas part of their path, and have thepackextension. This example uses a wildcard pattern. SeeExample 5, which uses regular expressions instead.
jf rt u "build/" my-release-local/files/ --exclusions="*install*pack*"
Example 5
Collect all files located under thebuilddirectory (including sub-directories), and upload them to themy-release-localrepository, under thefilesfolder, while maintaining the original names of the artifacts. Exclude (do not upload) files, which includeinstallas part of their path, and have thepackextension. This example uses a regular expression. SeeExample 4, which uses a wildcard pattern instead.
jf rt u "build/" my-release-local/files/ --regexp --exclusions="(.*)install.*pack$"
Example 6
Collect all files located under thebuilddirectory and match the**/*.zipANT pattern, and upload them to themy-release-localrepository, under thefilesfolder, while maintaining the original names of the artifacts.
jf rt u "build/**/*.zip" my-release-local/files/ --ant
Example 7
Package all files located under thebuilddirectory (including sub-directories) into a zip archive namedarchive.zip, and upload the archive to themy-local-reporepository,
$ jf rt u "build/" my-local-repo/my-archive.zip --archive zip
Downloading Files
This command is used to download files from Artifactory.
Remote download
By default, the command only downloads files which are cached on the current Artifactory instance. It does not download files located on remote Artifactory instances, through remote or virtual repositories. To allow the command to download files from remote Artifactory instances, which are proxied by the use of remote repositories, set theJFROG_CLI_TRANSITIVE_DOWNLOAD_EXPERIMENTALenvironment variable totrue。This functionality requires version 7.17 or above of Artifactory.
The remote download functionality is supported only on remote repositories which proxy repositories on remote Artifactory instances. Downloading through a remote repository which proxies non Artifactory repositories is not supported.
Command name |
rt download |
Abbreviation |
rt dl |
Command options |
When using the * or ; characters in the download command options or arguments, make sure to wrap the whole options or arguments string in quotes (") to make sure the * or ; characters are not interpreted as literals. |
--server-id |
[Optional] Server ID configured using the config command. If not specified, the default configured Artifactory server is used. |
| --build-name | [Optional] Build name. For more details, please refer toBuild Integration。 |
| --build-number | [Optional] Build number. For more details, please refer toBuild Integration。 |
| --project | [Optional] JFrog project key. |
| --module | [Optional] Optional module name for the build-info. |
| --spec | [Optional] Path to a file spec. For more details, please refer toUsing File Specs。 |
| --spec-vars | [Optional] 列表of variables in the form of "key1=value1;key2=value2;..." to be replaced in the File Spec. In the File Spec, the variables should be used as follows: ${key1}. |
| --props |
[Optional] A list of Artifactorypropertiesspecified as "key=value" pairs separated by a semi-colon (for example, "key1=value1;key2=value2;key3=value3"). Only artifacts withallof the specified properties names and values will be downloaded. |
| --exclude-props |
[Optional] A list of Artifactorypropertiesspecified as "key=value" pairs separated by a semi-colon (for example, "key1=value1;key2=value2;key3=value3"). Only artifactswithout allof the specified properties names and values will be downloaded. |
| --build | [Optional] If specified, only artifacts of the specified build are matched. The property format is build-name/build-number. If you do not specify the build number, the artifacts are filtered by the latest build number. |
| --bundle | [Optional] If specified, only artifacts of the specified bundle are matched. The value format is bundle-name/bundle-version. |
| --flat | [Default: false] If true, artifacts are downloaded to the exact target path specified and their hierarchy in the source repository is ignored. If false, artifacts are downloaded to the target path in the file system while maintaining their hierarchy in the source repository. Ifplaceholdersare used, and you would like the local file-system (download path) to be determined by placeholders only, or in other words, avoid concatenating the Artifactory folder hierarchy local, set to false. |
| --recursive | [Default: true] If true, artifacts are also downloaded from sub-paths under the specified path in the source repository. If false, only artifacts in the specified source path directory are downloaded. |
| --threads | [Default: 3] The number of parallel threads that should be used to download where each thread downloads a single artifact at a time. |
| --split-count | [Default: 3] The number of segments into which each file should be split for download (provided the artifact is over |
| --retries | [Default: 3] Number of download retries. |
| --retry-wait-time | [Default: 0s] Number of seconds or milliseconds to wait between retries. The numeric value should either end with s for seconds or ms for milliseconds. |
| --min-split | [Default: 5120] The minimum size permitted for splitting. Files larger than the specified number will be split into equally sized |
| --dry-run | [Default: false] If true, the command only indicates which artifacts would have been downloaded. If false, the command is fully executed and downloads artifacts as specified. |
| --explode | [Default: false] Set to true to extract an archive after it is downloaded from Artifactory. Supported compression formats: br, bz2, gz, lz4, sz, xz, zstd. Supported archive formats: zip, tar (including any compressed variants like tar.gz), rar. |
| --validate-symlinks | [Default: false] If true, the command will validate thatsymlinksare pointing to existing and unchanged files, by comparing their sha1. Applicable to files and not directories. |
| --include-dirs | [Default: false] If true, the source path applies to bottom-chain directories and not only to files. Botton-chain directories are either empty or do not include other directories that match the source path. |
| --exclusions | A list of Semicolon-separated exclude patterns. Allows using wildcards. |
--sync-deletes |
[Optional] Specific path in the local file system, under which to sync dependencies after the download. After the download, this path will include only the dependencies downloaded during this download operation. The other files under this path will be deleted. |
| --quiet | [Default: false] If true, the delete confirmation message is skipped. |
| --sort-by | [Optional] 以分号分隔的字段排序的列表。The fields must be part of the 'items' AQL domain. For more information read theAQL documentation |
| --sort-order | [Default: asc] The order by which fields in the 'sort-by' option should be sorted. Accepts 'asc' or 'desc'. |
| --limit | [Optional] The maximum number of items to fetch. Usually used with the 'sort-by' option. |
| --offset | [Optional] The offset from which to fetch items (i.e. how many items should be skipped). Usually used with the 'sort-by' option. |
| --fail-no-op | [Default: false] Set to true if you'd like the command to return exit code 2 in case of no files are affected. |
| --archive-entries | [Optional] If specified, only archive artifacts containing entries matching this pattern are matched. You can use wildcards to specify multiple artifacts. |
| --detailed-summary | [Default: false] Set to true to include a list of the affected files as part of the command output summary. |
| --insecure-tls | [Default: false] Set to true to skip TLS certificates verification. |
--gpg-key |
[Optional] Path to the public GPG key file located on the file system, used to validate downloaded release bundle files. |
Command arguments |
|
| Source path | Specifies the source path in Artifactory, from which the artifacts should be downloaded. You can use wildcards to specify multiple artifacts. |
| Target path | The second argument is optional and specifies the local file system target path. If the target path ends with a slash, the path is assumed to be a directory. For example, if you specify the target as "repo-name/a/b/", then "b" is assumed to be a directory into which files should be downloaded. If there is no terminal slash, the target path is assumed to be a file to which the downloaded file should be renamed. For example, if you specify the target as "a/b", the downloaded file is renamed to "b". For flexibility in specifying the target 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 toUsing Placeholders。 |
Examples
Example 1
Download an artifact calledcool-froggy.ziplocated at the root of themy-local-reporepository to the current directory.
摩根富林明rt dl my-local-repo / cool-froggy.zip美元
Example 2
Download all artifacts located under theall-my-frogsdirectory in themy-local-reporepository to theall-my-frogsfolder under the current directory.
$ jf rt dl my-local-repo/all-my-frogs/ all-my-frogs/
Example 3
Download all artifacts located in themy-local-reporepository with ajarextension to theall-my-frogsfolder under the current directory.
$ jf rt dl "my-local-repo/*.jar" all-my-frogs/
Example 4
Download thelatest file uploaded to theall-my-frogsfolder in themy-local-reporepository.
摩根富林明rt dl“my-local-repo / all-my-frogs /”——排序= created --sort-order=desc --limit=1
Copying Files
This command is used to copy files in Artifactory
Command name |
rt copy |
Abbreviation |
rt cp |
Command options |
When using the * or ; characters in the copy command options or arguments, make sure to wrap the whole options or arguments string in quotes (") to make sure the * or ; characters are not interpreted as literals. |
| --server-id | [Optional] Server ID configured using the config command. If not specified, the default configured Artifactory server is used. |
| --spec | [Optional] Path to a file spec. For more details, please refer toUsing File Specs。 |
| --props |
[Optional] A list of Artifactorypropertiesspecifiedas "key=value" pairs separated by a semi-colon. (For example, "key1=value1;key2=value2;key3=value3")。Only artifacts with these properties names and values will be copied. |
| --exclude-props |
[Optional] A list of Artifactorypropertiesspecified as "key=value" pairs separated by a semi-colon (for example, "key1=value1;key2=value2;key3=value3"). Only artifactswithout allof the specified properties names and values will be copied. |
| --build | [Optional] If specified, only artifacts of the specified build are matched. The property format is build-name/build-number. If you do not specify the build number, the artifacts are filtered by the latest build number. |
| --bundle | [Optional] If specified, only artifacts of the specified bundle are matched. The value format is bundle-name/bundle-version. |
| --flat | [Default: false] If true, artifacts are copied to the exact target path specified and their hierarchy in the source path is ignored. If false, artifacts are copied to the target path while maintaining their source path hierarchy. |
| --recursive | [Default: true] If true, artifacts are also copied from sub-paths under the specified source path. If false, only artifacts in the specified source path directory are copied. |
| --dry-run | [Default: false] If true, the command only indicates which artifacts would have been copied. If false, the command is fully executed and copies artifacts as specified. |
| --exclusions | A list of Semicolon-separated exclude patterns. Allows using wildcards. |
| --threads | [Default: 3] Number of threads used for copying the items. |
| --sort-by | [Optional] 以分号分隔的字段排序的列表。The fields must be part of the 'items' AQL domain. For more information read theAQL documentation |
| --sort-order | [Default: asc] The order by which fields in the 'sort-by' option should be sorted. Accepts 'asc' or 'desc'. |
| --limit | [Optional] The maximum number of items to fetch. Usually used with the 'sort-by' option. |
| --offset | [Optional] The offset from which to fetch items (i.e. how many items should be skipped). Usually used with the 'sort-by' option. |
| --fail-no-op | [Default: false] Set to true if you'd like the command to return exit code 2 in case of no files are affected. |
| --archive-entries | [Optional] If specified, only archive artifacts containing entries matching this pattern are matched. You can use wildcards to specify multiple artifacts. |
| --insecure-tls | [Default: false] Set to true to skip TLS certificates verification. |
| --retries | [Default: 3] Number for HTTP retry attempts. |
| --retry-wait-time | [Default: 0s] Number of seconds or milliseconds to wait between retries. The numeric value should either end with s for seconds or ms for milliseconds. |
Command arguments |
The command takes two arguments |
| Source path | Specifies the source path in Artifactory, from which the artifacts should be copied, in the following format: |
| Target path | Specifies the target path in Artifactory, to which the artifacts should be copied, in the following format: If the pattern ends with a slash, the target 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 copied. If there is no terminal slash, the target path is assumed to be a file to which the copied file should be renamed. For example, if you specify the target as "repo-name/a/b", the copied file is renamed to "b" in Artifactory. For flexibility in specifying the target 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 toUsing Placeholders。 |
Examples
Example 1
Copy all artifacts located under/rabbitin thesource-frog-reporepository into the same path in thetarget-frog-reporepository.
jf rt cp source-frog-repo/rabbit/ target-frog-repo/rabbit/
Example 2
Copy all zip files located under/rabbitin thesource-frog-reporepository into the same path in thetarget-frog-reporepository.
jf rt cp "source-frog-repo/rabbit/*.zip" target-frog-repo/rabbit/
Example 3
Copy all artifacts located under/rabbitin thesource-frog-reporepository and with property "Version=1.0" into the same path in thetarget-frog-reporepository .
jf rt cp "source-frog-repo/rabbit/*" target-frog-repo/rabbit/ --props=Version=1.0
Moving Files
This command is used to move files in Artifactory
Command name |
rt move |
Abbreviation |
rt mv |
Command options |
When using the * or ; characters in the copy command options or arguments, make sure to wrap the whole options or arguments string in quotes (") to make sure the * or ; characters are not interpreted as literals. |
| --server-id | [Optional] Server ID configured using the config command. If not specified, the default configured Artifactory server is used. |
| --spec | [Optional] Path to a file spec. For more details, please refer toUsing File Specs。 |
| --props |
[Optional] A list of Artifactorypropertiesspecifiedas "key=value" pairs separated by a semi-colon (for example, "key1=value1;key2=value2;key3=value3")。Only artifacts with these properties names and values will be moved. |
| --exclude-props |
[Optional] A list of Artifactorypropertiesspecified as "key=value" pairs separated by a semi-colon (for example, "key1=value1;key2=value2;key3=value3"). Only artifactswithout allof the specified properties names and values will be moved. |
| --build | [Optional] If specified, only artifacts of the specified build are matched. The property format is build-name/build-number. If you do not specify the build number, the artifacts are filtered by the latest build number. |
| --bundle | [Optional] If specified, only artifacts of the specified bundle are matched. The value format is bundle-name/bundle-version. |
| --flat | [Default: false] If true, artifacts are moved to the exact target path specified and their hierarchy in the source path is ignored. If false, artifacts are moved to the target path while maintaining their source path hierarchy. |
| --recursive | [Default: true] If true, artifacts are also moved from sub-paths under the specified source path. If false, only artifacts in the specified source path directory are moved. |
| --dry-run | [Default: false] If true, the command only indicates which artifacts would have been moved. If false, the command is fully executed and downloads artifacts as specified. |
| --exclusions | A list of Semicolon-separated exclude patterns. Allows using wildcards. |
| --threads | [Default: 3] Number of threads used for moving the items. |
| --sort-by | [Optional] 以分号分隔的字段排序的列表。The fields must be part of the 'items' AQL domain. For more information read theAQL documentation |
| --sort-order | [Default: asc] The order by which fields in the 'sort-by' option should be sorted. Accepts 'asc' or 'desc'. |
| --limit | [Optional] The maximum number of items to fetch. Usually used with the 'sort-by' option. |
| --offset | [Optional] The offset from which to fetch items (i.e. how many items should be skipped). Usually used with the 'sort-by' option. |
| --fail-no-op | [Default: false] Set to true if you'd like the command to return exit code 2 in case of no files are affected. |
| --archive-entries | [Optional] If specified, only archive artifacts containing entries matching this pattern are matched. You can use wildcards to specify multiple artifacts. |
| --insecure-tls | [Default: false] Set to true to skip TLS certificates verification. |
| --retries | [Default: 3] Number of HTTP retry attempts. |
| --retry-wait-time | [Default: 0s] Number of seconds or milliseconds to wait between retries. The numeric value should either end with s for seconds or ms for milliseconds. |
Command arguments |
The command takes two arguments |
| Source path | Specifies the source path in Artifactory, from which the artifacts should be moved, in the following format: |
| Target path | Specifies the target path in Artifactory, to which the artifacts should be moved, in the following format: If the pattern ends with a slash, the target 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 moved. If there is no terminal slash, the target path is assumed to be a file to which the moved file should be renamed. For example, if you specify the target as "repo-name/a/b", the moved file is renamed to "b" in Artifactory. 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 toUsing Placeholders。 |
Examples
Example 1
Move all artifacts located under/rabbitin thesource-frog-reporepository into the same path in thetarget-frog-reporepository.
jf rt mv source-frog-repo/rabbit/ target-frog-repo/rabbit/
Example 2
Move all zip files located under/rabbitin thesource-frog-reporepository into the same path in thetarget-frog-reporepository.
jf rt mv "source-frog-repo/rabbit/*.zip" target-frog-repo/rabbit/
Example 3
Move all artifacts located under/rabbitin thesource-frog-reporepository and with property "Version=1.0" into the same path in thetarget-frog-reporepository .
jf rt mv "source-frog-repo/rabbit/*" target-frog-repo/rabbit/ --props=Version=1.0
Deleting Files
This command is used to delete files in Artifactory
Command name |
rt delete |
Abbreviation |
rt del |
Command options |
When using the * or ; characters in the delete command options or arguments, make sure to wrap the whole options or arguments string in quotes (") to make sure the * or ; characters are not interpreted as literals. |
| --server-id | [Optional] Server ID configured using the config command. If not specified, the default configured Artifactory server is used. |
| --spec | [Optional] Path to a file spec. For more details, please refer toUsing File Specs。 |
| --props |
[Optional] A list of Artifactorypropertiesspecifiedas "key=value" pairs separated by a semi-colon (for example, "key1=value1;key2=value2;key3=value3")。Only artifacts with these properties names and values will be deleted. |
| --exclude-props |
[Optional] A list of Artifactorypropertiesspecified as "key=value" pairs separated by a semi-colon (for example, "key1=value1;key2=value2;key3=value3"). Only artifactswithout allof the specified properties names and values will be deleted. |
| --build | [Optional] If specified, only artifacts of the specified build are matched. The property format is build-name/build-number. If you do not specify the build number, the artifacts are filtered by the latest build number. |
| --bundle | [Optional] If specified, only artifacts of the specified bundle are matched. The value format is bundle-name/bundle-version. |
| --recursive | [Default: true] If true, artifacts are also deleted from sub-paths under the specified path. |
| --quiet | [Default: false] If true, the delete confirmation message is skipped. |
| --dry-run | [Default: false] If true, the command only indicates which artifacts would have been deleted. If false, the command is fully executed and deletes artifacts as specified. |
| --exclusions | A list of Semicolon-separated exclude patterns. Allows using wildcards. |
| --sort-by | [Optional] 以分号分隔的字段排序的列表。The fields must be part of the 'items' AQL domain. For more information read theAQL documentation |
| --sort-order | [Default: asc] The order by which fields in the 'sort-by' option should be sorted. Accepts 'asc' or 'desc'. |
| --limit | [Optional] The maximum number of items to fetch. Usually used with the 'sort-by' option. |
| --offset | [Optional] The offset from which to fetch items (i.e. how many items should be skipped). Usually used with the 'sort-by' option. |
| --fail-no-op | [Default: false] Set to true if you'd like the command to return exit code 2 in case of no files are affected. |
| --archive-entries | [Optional] If specified, only archive artifacts containing entries matching this pattern are matched. You can use wildcards to specify multiple artifacts. |
| --threads | [Default: 3] Number of threads used for deleting the items. |
| --insecure-tls | [Default: false] Set to true to skip TLS certificates verification. |
| --retries | [Default: 3] Number of HTTP retry attempts. |
| --retry-wait-time | [Default: 0s] Number of seconds or milliseconds to wait between retries. The numeric value should either end with s for seconds or ms for milliseconds.--retruy-wait-time |
Command arguments |
The command takes one argument |
| Delete path | Specifies the path in Artifactory of the files that should be deleted in the following format: |
Examples
Example 1
Delete all artifacts located under/rabbitin thefrog-reporepository.
jf rt del frog-repo/rabbit/
Example 2
Delete all zip files located under/rabbitin thefrog-reporepository.
jf rt del "frog-repo/rabbit/*.zip"
Searching Files
This command is used to search and display files in Artifactory.
Command name |
rt search |
Abbreviation |
rt s |
Command options |
When using the * or ; characters in the command options or arguments, make sure to wrap the whole options or arguments string in quotes (") to make sure the * or ; characters are not interpreted as literals. |
| --server-id | [Optional] Server ID configured using the config command. If not specified, the default configured Artifactory server is used. |
| --spec | [Optional] Path to a file spec. For more details, please refer toUsing File Specs。 |
| ——数 | [Optional] Set to true to display only the total of files or folders found. |
--include-dirs |
[Optional] Set to true if you'd like to also apply the source path pattern for directories and not only for files |
| --spec-vars | [Optional] 列表of variables in the form of "key1=value1;key2=value2;..." to be replaced in the File Spec. In the File Spec, the variables should be used as follows: ${key1}. |
| --props |
[Optional] A list of Artifactorypropertiesspecifiedas "key=value" pairs separated by a semi-colon (for example, "key1=value1;key2=value2;key3=value3")。Only artifacts with these properties names and values will be returned. |
| --exclude-props |
[Optional] A list of Artifactorypropertiesspecified as "key=value" pairs separated by a semi-colon (for example, "key1=value1;key2=value2;key3=value3"). Only artifactswithout allof the specified properties names and values will be returned. |
| --build | [Optional] If specified, only artifacts of the specified build are matched. The property format is build-name/build-number. If you do not specify the build number, the artifacts are filtered by the latest build number. |
| --bundle | [Optional] If specified, only artifacts of the specified bundle are matched. The value format is bundle-name/bundle-version. |
| --recursive | [Default: true] Set to false if you do not wish to search artifacts inside sub-folders in Artifactory. |
| --exclusions | A list of Semicolon-separated exclude patterns. Allows using wildcards. |
| --sort-by | [Optional] 以分号分隔的字段排序的列表。The fields must be part of the 'items' AQL domain. For more information read theAQL documentation |
| --sort-order | [Default: asc] The order by which fields in the 'sort-by' option should be sorted. Accepts 'asc' or 'desc'. |
| --transitive | [Default: false] Set to true to look for artifacts also in remote repositories. Available on Artifactory version 7.17.0 or higher. |
| --limit | [Optional] The maximum number of items to fetch. Usually used with the 'sort-by' option. |
| --offset | [Optional] The offset from which to fetch items (i.e. how many items should be skipped). Usually used with the 'sort-by' option. |
| --fail-no-op | [Default: false] Set to true if you'd like the command to return exit code 2 in case of no files are affected. |
| --archive-entries | [Optional] If specified, only archive artifacts containing entries matching this pattern are matched. You can use wildcards to specify multiple artifacts. |
| --insecure-tls | [Default: false] Set to true to skip TLS certificates verification. |
| --retries | [Default: 3] Number of HTTP retry attempts. |
| --retry-wait-time | [Default: 0s] Number of seconds or milliseconds to wait between retries. The numeric value should either end with s for seconds or ms for milliseconds.retry-wait-time |
Command arguments |
|
| Search path | Specifies the search path in Artifactory, in the following format: |
Examples
Example 1
Display a list of all artifacts located under/rabbitin thefrog-reporepository.
jf rt s frog-repo/rabbit/
Example 2
Display a list of all zip files located under/rabbitin thefrog-reporepository.
jf rt s "frog-repo/rabbit/*.zip"
Setting Properties on Files
This command is used for setting properties on existing files in Artifactory.
Command name |
rt set-props |
Abbreviation |
rt sp |
Command options |
When using the * or ; characters in the command options or arguments, make sure to wrap the whole options or arguments string in quotes (") to make sure the * or ; characters are not interpreted as literals. |
| --server-id | [Optional] Server ID configured using the config command. If not specified, the default configured Artifactory server is used. |
| --spec | [Optional] Path to a file spec. For more details, please refer toUsing File Specs。 |
| --spec-vars | [Optional] 列表of variables in the form of "key1=value1;key2=value2;..." to be replaced in the File Spec. In the File Spec, the variables should be used as follows: ${key1}. |
| --props | [Optional] 列表of properties in the form of "key1=value1;key2=value2,...". Only files with these properties names and values are affected. |
| --exclude-props |
[Optional] A list of Artifactorypropertiesspecified as "key=value" pairs separated by a semi-colon (for example, "key1=value1;key2=value2;key3=value3"). Only artifactswithout allof the specified properties names and values will be affected. |
| --recursive | [Default: true] When false, artifacts inside sub-folders in Artifactory will not be affected. |
| --build | [Optional] If specified, only artifacts of the specified build are matched. The property format is build-name/build-number. If you do not specify the build number, the artifacts are filtered by the latest build number. |
| --bundle | [Optional] If specified, only artifacts of the specified bundle are matched. The value format is bundle-name/bundle-version. |
| --include-dirs | [Default: false] When true, the properties will also be set on folders (and not just files) in Artifactory. |
| --fail-no-op | [Default: false] Set to true if you'd like the command to return exit code 2 in case of no files are affected. |
--exclusions |
A list of Semicolon-separated exclude patterns. Allows using wildcards. |
| --sort-by | [Optional] 以分号分隔的字段排序的列表。The fields must be part of the 'items' AQL domain. For more information read theAQL documentation |
| --sort-order | [Default: asc] The order by which fields in the 'sort-by' option should be sorted. Accepts 'asc' or 'desc'. |
| --limit | [Optional] The maximum number of items to fetch. Usually used with the 'sort-by' option. |
| --offset | [Optional] The offset from which to fetch items (i.e. how many items should be skipped). Usually used with the 'sort-by' option. |
| --archive-entries | [Optional] If specified, only archive artifacts containing entries matching this pattern are matched. You can use wildcards to specify multiple artifacts. |
| --insecure-tls | [Default: false] Set to true to skip TLS certificates verification. |
| --threads | [Default: 3] Number of working threads. |
| --retries | [Default: 3] Number of HTTP retry attempts. |
| --retry-wait-time | [Default: 0s] Number of seconds or milliseconds to wait between retries. The numeric value should either end with s for seconds or ms for milliseconds. |
Command arguments |
The command takes two arguments. |
| Files pattern | Files that match the pattern will be set with the specified properties. |
| Files properties | The list of properties, in the form of key1=value1;key2=value2,..., to be set on the matching artifacts. |
Example
Example 1
Set the properties on all the zip files in the generic-local repository. The command will set the property "a" with "1" value and the property "b" with two values: "2" and "3".
jf rt sp "generic-local/*.zip" "a=1;b=2,3"
Example 2
The command will set the property "a" with "1" value and the property "b" with two values: "2" and "3" on all files found by the File Spec my-spec.
jf rt sp "a=1;b=2,3" --spec my-spec
Deleting Properties from Files
This command is used for deleting properties from existing files in Artifactory.
Command name |
rt delete-props |
Abbreviation |
rt delp |
Command options |
When using the * or ; characters in the command options or arguments, make sure to wrap the whole options or arguments string in quotes (") to make sure the * or ; characters are not interpreted as literals. |
| --server-id | [Optional] Artifactory server ID configured using the config command. If not specified, the default configured Artifactory server is used. |
| --props | [Optional] 列表of properties in the form of "key1=value1;key2=value2,...". Only files with these properties are affected. |
| --exclude-props |
[Optional] A list of Artifactorypropertiesspecified as "key=value" pairs separated by a semi-colon (for example, "key1=value1;key2=value2;key3=value3"). Only artifactswithout allof the specified properties names and values will be affedcted. |
| --recursive | [Default: true] When false, artifacts inside sub-folders in Artifactory will not be affected. |
| --build | [Optional] If specified, only artifacts of the specified build are matched. The property format is build-name/build-number. If you do not specify the build number, the artifacts are filtered by the latest build number. |
| --bundle | [Optional] If specified, only artifacts of the specified bundle are matched. The value format is bundle-name/bundle-version. |
| --include-dirs | [Default: false] When true, the properties will also be set on folders (and not just files) in Artifactory. |
| --fail-no-op | [Default: false] Set to true if you'd like the command to return exit code 2 in case of no files are affected. |
--exclusions |
A list of Semicolon-separated exclude patterns. Allows using wildcards. |
| --sort-by | [Optional] 以分号分隔的字段排序的列表。The fields must be part of the 'items' AQL domain. For more information read theAQL documentation |
| --sort-order | [Default: asc] The order by which fields in the 'sort-by' option should be sorted. Accepts 'asc' or 'desc'. |
| --limit | [Optional] The maximum number of items to fetch. Usually used with the 'sort-by' option. |
| --offset | [Optional] The offset from which to fetch items (i.e. how many items should be skipped). Usually used with the 'sort-by' option. |
| --archive-entries | [Optional] If specified, only archive artifacts containing entries matching this pattern are matched. You can use wildcards to specify multiple artifacts. |
| --insecure-tls | [Default: false] Set to true to skip TLS certificates verification. |
| --retries | [Default: 3] Number of HTTP retry attempts. |
| --retruy-wait-time | [Default: 0s] Number of seconds or milliseconds to wait between retries. The numeric value should either end with s for seconds or ms for milliseconds.retry-wait-time |
Command arguments |
The command takes two arguments. |
| Files pattern | The properties will be deleted from files that match the pattern. |
| Files properties | The list of properties, in the form of key1,key2,..., to be deleted from the matching artifacts. |
Example
Delete the "status" and "phase" properties from all the zip files in the generic-local repository.
jf rt delp "generic-local/*.zip" "status,phase"
Creating Access Tokens
This command allows creatingAccess Tokensfor users in Artifactory
Command name |
rt access-token-create |
Abbreviation |
rt atc |
Command options |
|
--groups |
[Default: *] A list of comma-separated groups for the access token to be associated with. Specify * to indicate that this is a 'user-scoped token', i.e., the token provides the same access privileges that the current subject has, and is therefore evaluated dynamically. A non-admin user can only provide a scope that is a subset of the groups to which he belongs |
--grant-admin |
[Default: false] Set to true to provides admin privileges to the access token. This is only available for administrators. |
--expiry |
[Default: 3600] The time in seconds for which the token will be valid. To specify a token that never expires, set to zero. Non-admin can only set a value that is equal to or less than the default 3600. |
--refreshable |
[Default: false] 设置为真,如果你想要令牌耐火材料eshable. A refresh token will also be returned in order to be used to generate a new token once it expires. |
--audience |
[Optional] A space-separate list of the other Artifactory instances or services that should accept this token identified by their Artifactory Service IDs, as obtained by the 'jf rt curl api/system/service_id' command. |
Command arguments |
|
| username | Optional - The user name for which this token is created. If not specified, the configured user is used. |
Examples
Create an access token for the user with thecommander-will-rikerusername.
摩根富林明rt atc commander-will-riker美元
Cleaning Up Unreferenced Files from a Git LFS Repository
This command is used to clean up files from a Git LFS repository. This deletes all files from a Git LFS repository, which are no longer referenced in a corresponding Git repository.
Command name |
rt git-lfs-clean |
Abbreviation |
rt glc |
Command options |
|
--refs |
[Default: refs/remotes/*] List of Git references in the form of "ref1,ref2,..." which should be preserved. |
--repo |
[Optional] Local Git LFS repository in Artifactory which should be cleaned. If omitted, the repository is detected from the Git repository. |
--quiet |
[Default: false] Set to true to skip the delete confirmation message. |
--dry-run |
[Default: false] If true, cleanup is only simulated. No files are actually deleted. |
Command arguments |
If no arguments are passed in, the command assumes the .git repository is located at current directory. |
| path to .git | Path to the directory which includes the .git directory. |
Examples
Example 1
Cleans up Git LFS files from Artifactory, using the configuration in the .git directory located at the current directory.
$ jf rt glc
Example 2
Cleans up Git LFS files from Artifactory, using the configuration in the .git directory located inside the path/to/git/config directory.
$ jf rt glc path/to/git/config
Running cUrl
Execute a cUrl command, using the configured Artifactory details. The command expects the cUrl client to be included in the PATH.
This command supports only Artifactory REST APIs, which are accessible underhttps://
Command name |
rt curl |
|
Abbreviation |
rt cl | |
Command options |
||
--server-id |
[Optional] Server ID configured using thejfrog c add命令。If not specified, the default configured server is used. |
|
Command arguments |
||
| cUrl arguments and flags | The same list of arguments and flags passed to cUrl, except for the following changes:
|
Currently only servers configured with username and password / API key are supported.
Examples
Example 1
Execute the cUrl client, to sent a GET request to the /api/build endpoint to the default Artifactory server
jf rt curl -XGET /api/build
Example 2
Execute the cUrl client, to send a GET request to the /api/build endpoint to the configured my-rt-server server ID.
jf rt curl -XGET /api/build --server-id my-rt-server
Build Integration
Overview
与任何发展ecosyste JFrog CLI集成m allowing you to collect build-info and then publish it to Artifactory. By publishing build-info to Artifactory, JFrog CLI empowers Artifactory to provide visibility into artifacts deployed, dependencies used and extensive information on the build environment to allow fully traceable builds. Read more about build-info and build integration with Artifactoryhere。
Many of JFrog CLI's commands accept two optional command options:--build-nameand--build-number。当这些选项被添加,JFrog CLI collects and records the build info locally for these commands.
When running multiple commands using the same build and build number, JFrog CLI aggregates the collected build info into one build.
The recorded build-info can be later published to Artifactory using thebuild-publish命令。
Collecting Build-Info
Build-info is collected by adding the--build-nameand--build-numberoptions to different CLI commands. The CLI commands can be run several times and cumulatively collect build-info for the specified build name and number until it is published to Artifactory. For example, running thedownloadcommand several times with the same build name and number will accumulate each downloaded file in the corresponding build-info.
Collecting Dependencies
Dependencies are collected by adding the--build-nameand--build-numberoptions to thedownloadcommand .
For example, the following command downloads thecool-froggy.zipfile found in repositorymy-local-repo, but it also specifies this file as a dependency in buildmy-build-namewith build number 18:
|
Collecting Build Artifacts
Build artifacts are collected by adding the--build-nameand--build-numberoptions to the上传命令。
For example, the following command specifies that filefroggy.tgz上传ed to repositorymy-local-repois a build artifact of buildmy-build-namewith build number 18:
jf rt u froggy.tgz my-local-repo --build-name=my-build-name --build-number=18
Collecting Environment Variables
This command is used to collect environment variables and attach them to a build.
Environment variables are collected using thebuild-collect-env(bce) command.
For example, the following command collects all currently known environment variables, and attaches them to the build-info for buildmy-build-namewith build number 18:
jf rt bce my-build-name 18
The following table lists the command arguments and flags:
Command name |
rt build-collect-env |
Abbreviation |
rt bce |
Command options |
|
| --project | [Optional] JFrog project key. |
Command arguments |
The command accepts two arguments. |
| Build name | Build name. |
| Build number | Build number. |
Example
Collect environment variables for build name: frogger-build and build number: 17
jf rt bce frogger-build 17
Collecting Information from Git
Thebuild-add-git(袋)命令收集Git修订和URL from the local .git directory and adds it to the build-info. It can also collect the list of tracked project issues (for example, issues stored in JIRA or other bug tracking systems) and add them to the build-info. The issues are collected by reading the git commit messages from the local git log. Each commit message is matched against a pre-configured regular expression, which retrieves the issue ID and issue summary. The information required for collecting the issues is retrieved from a yaml configuration file provided to the command.
The following table lists the command arguments and flags:
Command name |
rt build-add-git |
Abbreviation |
rt bag |
Command options |
|
| --config | [Optional] Path to a yaml configuration file, used for collecting tracked project issues and adding them to the build-info. |
| --server-id | [Optional] Server ID configured using thejfrog config command。This is the server to which the build-info will be later published, using the |
| --project | [Optional] JFrog project key. |
Command arguments |
The command accepts three arguments. |
| Build name | Build name. |
| Build number | Build number. |
| 。git path | Optional - Path to a directory containing the .git directory. If not specific, the .git directory is assumed to be in the current directory or in one of the parent directories. |
Example
|
This is the configuration file structure.
版本:1问题:#服务公司erID yaml property is optional. The --server-id command option, if provided, overrides the serverID value. # If both the serverID property and the --server-id command options are not provided, # the default server, configured by the "jfrog config add" command is used. serverID: my-artifactory-server trackerName: JIRA regexp: (.+-[0-9]+)\s-\s(.+) keyGroupIndex: 1 summaryGroupIndex: 2 trackerUrl: http://my-jira.com/issues aggregate: true aggregationStatus: RELEASED
Configuration file properties
| Property name | Description |
|---|---|
| Version | The schema version is intended for internal use. Do not change! |
| serverID | Artifactory server ID configured by thejfrog config command。The command uses this server for fetching details about previous published builds. The--server-idcommand option, if provided, overrides theserverIDvalue. If both theserverIDproperty and the--server-idcommand options are not provided, the default server, configured by thejfrog config commandis used. |
| trackerName | The name (type) of the issue tracking system. For example, JIRA. This property can take any value. |
regexp |
A regular expression used for matching the git commit messages. The expression should include two capturing groups - for the issue key (ID) and the issue summary. In the example above, the regular expression matches the commit messages as displayed in the following example: HAP-1007 - This is a sample issue |
| keyGroupIndex | The capturing group index in the regular expression used for retrieving the issue key. In the example above, setting the index to "1" retrievesHAP-1007from this commit message: HAP-1007 - This is a sample issue |
| summaryGroupIndex | The capturing group index in the regular expression for retrieving the issue summary. In the example above, setting the index to "2" retrievesthesample issue from this commit message: HAP-1007 - This is a sample issue |
| trackerUrl | The issue tracking URL. This value is used for constructing a direct link to the issues in the Artifactory build UI. |
aggregate |
Set to true, if you wish all builds to include issues from previous builds. |
aggregationStatus |
If aggregate is set to true, this property indicates how far in time should the issues be aggregated. In the above example, issues will be aggregated from previous builds, until a build with a RELEASE status is found. Build statuses are set when a build is promoted using thejf rt build-promote命令。 |
Adding Files as Build Dependencies
The download command, as well as other commands which download dependencies from Artifactory accept the--build-nameand--build-numbercommand options. Adding these options records the downloaded files as build dependencies. In some cases however,it is necessary to add a file, which has been downloaded by another tool, to a build. Use thebuild-add-dependenciescommand to to this.
By default, the command collects the files from the local file system. If you'd like the files to be collected from Artifactory however, add the--from-rtoption to the command.
Command name |
rt build-add-dependencies |
Abbreviation |
rt bad |
Command options |
When using the * or ; characters in the command options or arguments, make sure to wrap the whole options or arguments string in quotes (") to make sure the * or ; characters are not interpreted as literals. |
| --from-rt | [Default: false] Set to true to search the files in Artifactory, rather than on the local file system. The --regexp option is not supported when --from-rt is set to true. |
--server-id |
[Optional] Server ID configured using the config command. |
--spec |
[Optional] Path to a File Spec. |
--spec-vars |
[Optional] 列表of variables in the form of "key1=value1;key2=value2;..." to be replaced in the File Spec. In the File Spec, the variables should be used as follows: ${key1}. |
| --recursive | [Default: true] When false, artifacts inside sub-folders in Artifactory will not be affected. |
--regexp |
[Optional: false] [Default: false] Set to true to use a regular expression instead of wildcards expression to collect files to be added to the build info.This option is not supported when --from-rt is set to true. |
--dry-run |
[Default: false] Set to true to only get a summery of the dependencies that will be added to the build info. |
--exclusions |
A list of Semicolon-separated exclude patterns. Allows using wildcards or a regular expression according to the value of the 'regexp' option. |
Command arguments |
The command takes threee arguments. |
| Build name | The build name to add the dependencies to |
| Build number | The build number to add the dependencies to |
| Pattern | Specifies the local file system path to dependencies which should be added to the build info.You can specify multiple dependencies by using wildcards or a regular expression as designated by the --regexp command option. If you have specified that you are using regular expressions, then the first one used in the argument must be enclosed in parenthesis. |
Example
Example 1
Add all files located under thepath/to/build/dependencies/dir/directory as depedencies of a build. The build name ismy-build-nameand the build number is7。The build-info is only updated locally. To publish the build-info to Artifactory use thejf rt build-publish命令。
jf rt bad my-build-name 7 "path/to/build/dependencies/dir/"
Example 2
Add all files located in them-local-repoArtifactory repository, under thedependenciesfolder, as depedencies of a build. The build name ismy-build-nameand the build number is7。The build-info is only updated locally. To publish the build-info to Artifactory use thejf rt build-publish命令。
jf rt bad my-build-name 7 "my-local-repo/dependencies/" --from-rt
Publishing Build-Info
This command is used to publish build info to Artifactory. To publish the accumulated build-info for a build to Artifactory, use thebuild-publish(bp)命令。For example, the following command publishes all the build-info collected for buildmy-build-namewith build number 18:
jf bp my-build-name 18
This command is used to publish build info to Artifactory.
Command name |
rt build-publish |
Abbreviation |
rt bp |
Command options |
|
| --server-id | [Optional] Server ID configured using the config command. If not specified, the default configured Artifactory server is used. |
| --project | [Optional] JFrog project key. |
--build-url |
[Optional] Can be used for setting the CI server build URL in the build-info. |
| --env-include | [Default: *] 列表of patterns in the form of "value1;value2;..." Only environment variables that match those patterns will be included in the build info. |
| --env-exclude | [Default: *password*;*secret*;*key*] 列表of case insensitive patterns in the form of "value1;value2;..." environment variables match those patterns will be excluded. |
--dry-run |
[Default: false] Set to true to disable communication with Artifactory. |
| --insecure-tls | [Default: false] Set to true to skip TLS certificates verification. |
Command arguments |
The command accepts two arguments. |
| Build name | Build name to be published. |
| Build number | Build number to be published. |
Example
|
Aggregating Published Builds
build-info,收集和发布to Artifactory by thejf rt build-publishcommand, can include multiple modules. Each module in the build-info represents a package, which is the result of a single build step, or in other words, a JFrog CLI command execution. For example, the following command adds a module namedm1to a build namedmy-buildwith1as the build number:
jf rt upload "a/*.zip" generic-local --build-name my-build --build-number 1 --module m1
The following command, adds a second module, namedm2to the same build:
jf rt upload "b/*.zip" generic-local --build-name my-build --build-number 1 --module m2
You now publish the generated build-info to Artifactory using the following command:
jf rt build-publish my-build 1
Now that you have your build-info published to Artifactory, you can perform actions on the entire build. For example, you can download, copy, move or delete all or some of the artifacts of a build. Here's how you do this.
jf rt download "*" --build my-build/1
在some cases though, your build is composed of multiple build steps, which are running on multiple different machines or spread across different time periods. How do you aggregate those build steps, or in other words, aggregate those command executions, into one build-info?
The way to do this, is to create a separate build-info for every section of the build, and publish it independently to Artifactory. Once all the build-info instances are published, you can create a new build-info, which references all the previously published build-info instances. The new build-info can be viewed as a "master" build-info, which references other build-info instances.
So the next question is - how can this reference between the two build-instances be created?
The way to do this is by using thebuild-append命令。Running this command on an unpublished build-info, adds a reference to a different build-info, which has already been published to Artifactory. This reference is represented by a new module in the new build-info. The ID of this module will have the following format:
Now, when downloading the artifacts of the "master" build, you'll actually be downloading the artifacts of all of its referenced builds. The examples below demonstrates this,
Command name |
rt build-append |
Abbreviation |
rt ba |
Command options |
This command has no options. |
Command arguments |
The command accepts four arguments. |
| Build name | The current (not yet published) build name. |
| Build number | The current (not yet published) build number, |
build name to append |
The published build name to append to the current build |
| build number to append | The published build number to append to the current build |
需求
Artifactory version 7.25.4 and above.
Example
# Create and publish build a/1 jf rt upload "a/*.zip" generic-local --build-name a --build-number 1 jf rt build-publish a 1 # Create and publish build b/1 jf rt upload "b/*.zip" generic-local --build-name b --build-number 1 jf rt build-publish b 1 # Append builds a/1 and b/1 to build aggregating-build/10 jf rt build-append aggregating-build 10 a 1 jf rt build-append aggregating-build 10 b 1 # Publish build aggregating-build/10 jf rt build-publish aggregating-build 10 # Download the artifacts of aggregating-build/10, which is the same as downloadiong the of a/1 and b/1 jf rt download --build aggregating-build/10
Promoting a Build
This command is used topromote buildin Artifactory.
Command name |
rt build-promote |
Abbreviation |
rt bpr |
Command options |
|
| --server-id | [Optional] Server ID configured using the config command. If not specified, the default configured Artifactory server is used. |
| --project | [Optional] JFrog project key. |
| --status | [Optional] Build promotion status. |
| --comment | [Optional] Build promotion comment. |
| --source-repo | [Optional] Build promotion source repository. |
| --include-dependencies | [Default: false] If set to true, the build dependencies are also promoted. |
| --copy | [Default: false] If set true, the build artifacts and dependencies are copied to the target repository, otherwise they are moved. |
| --props | [Optional] 列表of properties in the form of "key1=value1;key2=value2,...". to attach to the build artifacts. |
| --dry-run | [Default: false] If true, promotion is only simulated. The build is not promoted. |
| --insecure-tls | [Default: false] Set to true to skip TLS certificates verification. |
Command arguments |
The command accepts three arguments. |
| Build name | Build name to be promoted. |
| Build number | Build number to be promoted. |
| Target repository | Build promotion target repository. |
Example
|
Cleaning up the Build
Build-info is accumulated by the CLI according to the commands you apply until you publish the build-info to Artifactory. If, for any reason, you wish to "reset" the build-info and cleanup (i.e. delete) any information accumulated so far, you can use thebuild-clean(bc) command.
The following table lists the command arguments and flags:
Command name |
rt build-clean |
Abbreviation |
rt bc |
Command options |
The command has no options. |
Command arguments |
The command accepts two arguments. |
| Build name | Build name. |
| Build number | Build number. |
For example, the following command cleans up any build-info collected for buildmy-build-namewith build number 18:
|
Discarding Old Builds from Artifactory
This command is used to discard builds previously published to Artifactory using thebuild-publish命令。
The following table lists the command arguments and flags:
Command name |
rt build-discard |
Abbreviation |
rt bdi |
Command options |
|
| --server-id | [Optional] Sserver ID configured using the config command. If not specified, the default configured Artifactory server is used. |
| --max-days | [Optional] The maximum number of days to keep builds in Artifactory. |
| --max-builds | [Optional] The maximum number of builds to store in Artifactory. |
| --exclude-builds | [Optional] 列表of build numbers in the form of "value1,value2,...", that should not be removed from Artifactory. |
| --delete-artifacts | [Default: false] If set to true, automatically removes build artifacts stored in Artifactory. |
| --async | [Default: false] If set to true, build discard will run asynchronously and will not wait for response. |
Command arguments |
The command accepts one argument. |
| Build name | Build name. |
Example
Example 1
Discard the oldest build numbers of buildmy-build-namefrom Artifactory, leaving only the 10 most recent builds.
|
Example 2
Discard the oldest build numbers of buildmy-build-namefrom Artifactory, leaving only builds published during the last 7 days.
|
Example 3
Discard the oldest build numbers of buildmy-build-namefrom Artifactory, leaving only builds published during the last 7 days.b20andb21will not be discarded.
|
Package Managers Integration
Running Maven Builds
JFrog CLI includes integration with Maven, allowing you to to resolve dependencies and deploy build artifacts from and to Artifactory, while collecting build-info and storing it in Artifactory.
Setting maven repositories
Before using themvncommand, the project needs to be pre-configured with the Artifactory server and repositories, to be used for building and publishing the project. Themvn-configcommand should be used once to add the configuration to the project. The command should run while inside the root directory of the project. The configuration is stored by the command in the。jfrogdirectory at the root directory of the project.
Command-name |
mvn-config |
Abbreviation |
mvnc |
Command options |
|
--global |
[Optional] Set to true, if you'd like the configuration to be global (for all projects on the machine). Specific projects can override the global configuration. |
| --server-id-resolve | [Optional] Server ID for resolution. The server should configured using the 'jf rt c' command. |
| --server-id-deploy | [Optional] Server ID for deployment. The server should be configured using the 'jf rt c' command. |
| --repo-resolve-releases | [Optional] Resolution repository for release dependencies. |
| --repo-resolve-snapshots | [Optional] Resolution repository for snapshot dependencies. |
| --repo-deploy-releases | [Optional] Deployment repository for release artifacts. |
| --repo-deploy-snapshots | [Optional] Deployment repository for snapshot artifacts. |
| --include-patterns | [Optional] Filter deployed artifacts by setting a wildcard pattern that specifies which artifacts to include. You may provide multiple patterns separated by a comma followed by a white-space. For example artifact-*.jar, artifact-*.pom |
| --exclude-patterns | [Optional] Filter deployed artifacts by setting a wildcard pattern that specifies which artifacts to exclude. You may provide multiple patterns separated by a comma followed by a white-space. For example artifact-*-test.jar, artifact-*-test.pom |
| --scan | [Default: false] Set if you'd like all files to be scanned by Xray on the local file system prior to the upload, and skip the upload if any of the files are found vulnerable. |
| --format | [Default: table] Should be used with the --scan option. Defines the scan output format. Accepts table or json as values. |
Command arguments |
The command accepts no arguments |
Running maven
Themvncommand triggers the maven client, while resolving dependencies and deploying artifacts from and to Artifactory.
Before running themvncommand on a project for the first time, the project should be configured with themvn-config命令。
If the machine running JFrog CLI has no access to the internet, make sure to read theDownloading the Maven and Gradle Extractor JARssection.
The following table lists the command arguments and flags:
Command-name |
mvn |
Abbreviation |
mvn |
Command options |
|
| --threads | [Default: 3] Number of threads for uploading build artifacts. |
--build-name |
[Optional] Build name. For more details, please refer toBuild Integration。 |
--build-number |
[Optional] Build number. For more details, please refer toBuild Integration。 |
| --project | [Optional] JFrog project key. |
--insecure-tls |
[Default: false] Set to true to skip TLS certificates verification. |
Command arguments |
The command accepts the same arguments and options as the mvn client. |
Deploying Maven Artifacts
The deployment to Artifacts is triggered both by the deploy and install phases.
To disable artifacts deployment, add-Dartifactory.publish.artifacts=falseto the list of goals and options.
For example: "clean install-Dartifactory.publish.artifacts=false"
Examples
Example 1
Run clean and install with maven.
jf mvn clean install -f path/to/pom-file
Running Gradle Builds
JFrog CLI includes integration with Gradle, allowing you to to resolve dependencies and deploy build artifacts from and to Artifactory, while collecting build-info and storing it in Artifactory.
Setting gradle repositories
Before using thegradlecommand, the project needs to be pre-configured with the Artifactory server and repositories, to be used for building and publishing the project. Thegradle-configcommand should be used once to add the configuration to the project. The command should run while inside the root directory of the project. The configuration is stored by the command in the。jfrogdirectory at the root directory of the project.
Command-name |
gradle-config |
Abbreviation |
gradlec |
Command options |
|
--global |
[Optional] Set to true, if you'd like the configuration to be global (for all projects on the machine). Specific projects can override the global configuration. |
| --server-id-resolve | [Optional] Server ID for resolution. The server should configured using the 'jf c add' command. |
| --server-id-deploy | [Optional] Server ID for deployment. The server should be configured using the 'jf c add' command. |
| --repo-resolve | [Optional] Repository for dependencies resolution. |
| --repo-deploy | [Optional] Repository for artifacts deployment. |
| --uses-plugin | [Default: false] Set to true if the Gradle Artifactory Plugin is already applied in the build script. |
| --use-wrapper | [Default: false] Set to true if you'd like to use the Gradle wrapper. |
| --deploy-maven-desc | [Default: true] Set to false if you do not wish to deploy Maven descriptors. |
| --deploy-ivy-desc | [Default: true] Set to false if you do not wish to deploy Ivy descriptors. |
| --ivy-desc-pattern | [Default: '[organization]/[module]/ivy-[revision].xml' Set the deployed Ivy descriptor pattern. |
| --ivy-artifacts-pattern | [Default: '[organization]/[module]/[revision]/[artifact]-[revision](-[classifier]).[ext]' Set the deployed Ivy artifacts pattern. |
| --scan | [Default: false] Set if you'd like all files to be scanned by Xray on the local file system prior to the upload, and skip the upload if any of the files are found vulnerable. |
| --format | [Default: table] Should be used with the --scan option. Defines the scan output format. Accepts table or json as values. |
Command arguments |
The command accepts no arguments |
Running gradle
Thegradlecommand triggers the gradle client, while resolving dependencies and deploying artifactds from and to Artifactory.
Before running thegradlecommand on a project for the first time, the project should be configured with thegradle-config命令。
If the machine running JFrog CLI has no access to the internet, make sure to read theDownloading the Maven and Gradle Extractor JARssection.
The following table lists the command arguments and flags:
Command-name |
gradle |
Abbreviation |
gradle |
Command options |
|
| --threads | [Default: 3] Number of threads for uploading build artifacts. |
--build-name |
[Optional] Build name. For more details, please refer toBuild Integration。 |
--build-number |
[Optional] Build number. For more details, please refer toBuild Integration。 |
| --project | [Optional] JFrog project key. |
Command arguments |
The command accepts the same arguments and options as the gradle client. |
Examples
Example 1
Build the project using theartifactoryPublishtask, while resolving and deploying artifacts from and to Artifactory.
jf gradle clean artifactoryPublish -b path/to/build.gradle
Running Builds with MSBuild
JFrog CLI includes integration with MSBuild and Artifactory, allowing you to resolve dependencies and deploy build artifacts from and to Artifactory, while collecting build-info and storing it in Artifactory. This is done by having JFrog CLI in your search path and adding JFrog CLI commands to the MSBuildcsprojfile.
For detailed instructions, please refer to ourMSBuild Project Exampleon GitHub.
Managing Docker Images
JFrog CLI provides full support for pulling and publishing docker images from and to Artifactory using the docker client running on the same machine. This allows you to to collectbuild-info for your docker build and then publish it to Artifactory. You can also promote the pushed docker images from one repository to another in Artifactory.
To build and push your docker images to Artifactory, follow these steps:
- Make sure Artifactory can be used as docker registry. Please refer toGetting Started with Docker and Artifactoryin the JFrog Artifactory User Guide.
- Make sure that the installed docker client has version17.07.0-ce (2017-08-29)or above. To verify this, rundocker -v
To ensure that the docker client and your Artifactory docker registry are correctly configured to work together, run the following code snippet.
docker pull hello-world docker tag hello-world:latest
/hello-world:latest docker login docker push /hello-world:latest If everything is configured correctly, pushing any image including the hello-world image should be successfully uploaded to Artifactory.
docker commands with the CLI
When running the docker-pull and docker-push commands, the CLI will first attempt to login to the docker registry.
在case of a login failure, the command will not be executed.
Examples
Check out ourdocker project examples on GitHub。
Pulling Docker Images Using the Docker Client
Runningdocker-pullcommand allows pulling docker images from Artifactory,while collecting the build-info and storing it locally, so that it can be later published to Artifactory, using thebuild-publish命令。
The following table lists the command arguments and flags:
Command-name |
docker pull |
Abbreviation |
dpl |
Command options |
|
--server-id |
[Optional] Server ID configured using the config command. If not specified, the default configured Artifactory server is used. |
--build-name |
[Optional] Build name. For more details, please refer toBuild Integration。 |
--build-number |
[Optional] Build number. For more details, please refer toBuild Integration。 |
| --project | [Optional] JFrog project key. |
| --module | [Optional] Optional module name for the build-info. |
| --skip-login | [Default: false] Set to true if you'd like the command to skip performing docker login. |
Command arguments |
The same arguments and options supported by the docker client/ |
Examples
jf docker pull my-docker-registry.io/my-docker-image:latest --build-name=my-build-name --build-number=7
You can then publish the build-info collected by thedocker-pullcommand to Artifactory using thebuild-publish命令。
Pushing Docker Images Using the Docker Client
After building your image using the docker client, thedocker-pushcommand pushes the image layers to Artifactory, while collecting the build-info and storing it locally, so that it can be later published to Artifactory, using thebuild-publish命令。
The following table lists the command arguments and flags:
Command-name |
docker push |
Abbreviation |
dp |
Command options |
|
--server-id |
[Optional] Server ID configured using the config command. If not specified, the default configured Artifactory server is used. |
--build-name |
[Optional] Build name. For more details, please refer toBuild Integration。 |
--build-number |
[Optional] Build number. For more details, please refer toBuild Integration。 |
| --project | [Optional] JFrog project key. |
| --module | [Optional] Optional module name for the build-info. |
| --skip-login | [Default: false] Set to true if you'd like the command to skip performing docker login. |
--threads |
[Default: 3] Number of working threads. |
| --detailed-summary | [Default: false] Set true to include a list of the affected files as part of the command output summary. |
Command arguments |
The same arguments and options supported by the docker client/ |
Examples
jf docker push my-docker-registry.io/my-docker-image:latest --build-name=my-build-name --build-number=7
You can then publish the build-info collected by thedocker-pushcommand to Artifactory using thebuild-publish命令。
拉码头工人使用Podman图像
Podmanis a daemonless container engine for developing, managing, and running OCI Containers.Running thepodman-pullcommand allows pulling docker images from Artifactory using podman, while collecting the build-info and storing it locally, so that it can be later published to Artifactory, using thebuild-publish命令。
The following table lists the command arguments and flags:
Command-name |
rt podman-pull |
Abbreviation |
rt ppl |
Command options |
|
--server-id |
[Optional] Server ID configured using the config command. If not specified, the default configured Artifactory server is used. |
--build-name |
[Optional] Build name. For more details, please refer toBuild Integration。 |
--build-number |
[Optional] Build number. For more details, please refer toBuild Integration。 |
| --project | [Optional] JFrog project key. |
| --module | [Optional] Optional module name for the build-info. |
| --skip-login | [Default: false] Set to true if you'd like the command to skip performing docker login. |
Command argument |
|
Image tag |
The docker image tag to pull. |
| Source repository | Source repository in Artifactory. |
Examples
jf rt podman-pull my-docker-registry.io/my-docker-image:latest docker-local --build-name=my-build-name --build-number=7
You can then publish the build-info collected by thepodman-pullcommand to Artifactory using thebuild-publish命令。
Pushing Docker Images Using Podman
Podmanis a daemonless container engine for developing, managing, and running OCI Containers. After building your image, the podman-pushcommand pushes the image layers to Artifactory, while collecting the build-info and storing it locally, so that it can be later published to Artifactory, using thebuild-publish命令。
The following table lists the command arguments and flags:
Command-name |
rt podman-push |
Abbreviation |
rt pp |
Command options |
|
--server-id |
[Optional] Server ID configured using the config command. If not specified, the default configured Artifactory server is used. |
--build-name |
[Optional] Build name. For more details, please refer toBuild Integration。 |
--build-number |
[Optional] Build number. For more details, please refer toBuild Integration。 |
| --project | [Optional] JFrog project key. |
| --module | [Optional] Optional module name for the build-info. |
| --skip-login | [Default: false] Set to true if you'd like the command to skip performing docker login. |
--threads |
[Default: 3] Number of working threads. |
| --detailed-summary | [Default: false] Set to true to include a list of the affected files as part of the command output summary. |
Command argument |
|
Image tag |
The docker image tag to push. |
| Target repository | Target repository in Artifactory. |
Examples
jf rt podman-push my-docker-registry.io/my-docker-image:latest docker-local --build-name=my-build-name --build-number=7
You can then publish the build-info collected by thepodman-pushcommand to Artifactory using thebuild-publish命令。
Pushing Docker Images Using Kaniko
JFrog CLI allows pushing containers to Artifactory usingKaniko, while collecting build-info and storing it in Artifactory.
For detailed instructions, please refer to ourKaniko project example on GitHub。
Pushing Docker Images Using buildx
JFrog CLI allows pushing containers to Artifactory usingbuildx, while collecting build-info and storing it in Artifactory.
For detailed instructions, please refer to ourbuildx project example on GitHub。
Pushing Docker Images Using the OpenShift CLI
JFrog CLI allows pushing containers to Artifactory using theOpenShift CLI, while collecting build-info and storing it in Artifactory.
For detailed instructions, please refer to ourOpenShift build project example on GitHub。
Adding Published Docker Images to the Build-Info
Thebuild-docker-createcommand allows adding a docker image, which is already published to Artifactory, into the build-info. This build-infocan be later published to Artifactory, using thebuild-publish命令。
Command-name |
rt build-docker-create |
Abbreviation |
rt bdc |
Command options |
|
| --image-file |
Path to a file which includes one line in the following format: IMAGE-TAG@sha256:MANIFEST-SHA256. For example: cat image-file-details superfrog-docker.jfrog.io/hello-frog@sha256:30f04e684493fb5ccc030969df6de0 |
--server-id |
[Optional] Server ID configured using the config command. If not specified, the default configured Artifactory server is used. |
--build-name |
[Optional] Build name. For more details, please refer toBuild Integration。 |
--build-number |
[Optional] Build number. For more details, please refer toBuild Integration。 |
| --project | [Optional] JFrog project key. |
| --module | [Optional] Optional module name for the build-info. |
| --skip-login | [Default: false] Set to true if you'd like the command to skip performing docker login. |
--threads |
[Default: 3] Number of working threads. |
Command argument |
|
| Target repository | The name of the repository to which the image was pushed. |
Examples
jf rt bdc docker-local --image-file image-file-details --build-name myBuild --build-number 1
You can then publish the build-info collected by thepodman-pushcommand to Artifactory using thebuild-publish命令。
Promoting Docker Images
Promotion is the action of moving or copying a group of artifacts from one repository to another, to support the artifacts lifecycle. When it comes to docker images, there are two ways to ways to promote a docker image which was pushed to Artifactory:
- Create build-info for the docker image, and then promote the build using thejf rt build-promote命令。
- Use thejf rt docker-promotecommand as described below.
The following table lists the command arguments and flags:
Command-name |
rt docker-promote |
Abbreviation |
rt dpr |
Command options |
|
--server-id |
[Optional] Server ID configured using the config command. If not specified, the default configured Artifactory server is used. |
--copy |
[Default: false] If set true, the Docker image is copied to the target repository, otherwise it is moved. |
--source-tag |
[Optional] The tag name to promote. |
--target-docker-image |
[Optional] Docker target image name. |
--target-tag |
[Optional] The target tag to assign the image after promotion. |
Command argument |
|
source docker image |
The docker image name to promote. |
| source repository | Source repository in Artifactory. |
| target repository | Target repository in Artifactory. |
Examples
Promote thehello worlddocker image from thedocker-dev-localrepository to thedocker-staging-localrepository.
jf rt docker-promote hello-world docker-dev-local docker-staging-local
Building Npm Packages Using the Npm Client
JFrog CLI provides full support for building npm packages using the npm client. This allows you to resolve npm dependencies,and publish your npm packages from and to Artifactory, while collecting build-info and storing it in Artifactory.
Follow these guidelines when buildingnpmpackages:
You can download npm packages from any npm repository type - local, remote or virtual, but you can only publish to a local or virtual Artifactory repository, containing local repositories. To publish to a virtual repository, you first need to set a default local repository. For more details, please refer toDeploying to a Virtual Repository。
When the
npm-publishcommand runs, JFrog CLI runs thepackcommand in the background. The pack action is followed by an upload, which is not based on the npm client's publish command. Therefore,If your npm package includes theprepublishorpostpublishscripts, rename them toprepackandpostpack, respectively.
需求
Npm client version 5.4.0 and above.
Artifactory version 5.5.2 and above.
Setting npm repositories
Before using thenpm-install,npm-ciandnpm-publishcommands, the project needs to be pre-configured with the Artifactory server and repositories, to be used for building and publishing the project. Thenpm-configcommand should be used once to add the configuration to the project. The command should run while inside the root directory of the project. The configuration is stored by the command in the。jfrogdirectory at the root directory of the project.
Command-name |
npm-config |
Abbreviation |
npmc |
Command options |
|
--global |
[Optional] Set to true, if you'd like the configuration to be global (for all projects on the machine). Specific projects can override the global configuration. |
| --server-id-resolve | [Optional] Artifactory server ID for resolution. The server should configured using the 'jfrog c add' command. |
| --server-id-deploy | [Optional] Artifactory server ID for deployment. The server should be configured using the 'jfrog c add' command. |
| --repo-resolve | [Optional] Repository for dependencies resolution. |
| --repo-deploy | [Optional] Repository for artifacts deployment. |
Command arguments |
The command accepts no arguments |
在stalling Npm Packages
Thenpm-installandnpm-cicommands execute npm'sinstallandcicommands respectively, to fetches the npm dependencies from the npm repositories.
Before running thenpm-installornpm-cicommand on a project for the first time, the project should be configured using thenpm-config命令。
The following table lists the command arguments and flags:
Command-name |
npm |
Abbreviation |
|
Command options |
|
--build-name |
[Optional] Build name. For more details, please refer toBuild Integration。 |
--build-number |
[Optional] Build number. For more details, please refer toBuild Integration。 |
| --project | [Optional] JFrog project key. |
| --module | [Optional] Optional module name for the build-info. |
| --threads | [Default: 3] Number of working threads for build-info collection. |
Command arguments |
The command accepts the same arguments and options as the npm client. |
Examples
Example 1
The following example installs the dependencies and records them locally as part of buildmy-build-name/1。The build-info can later be published to Artifactory using thebuild-publish命令。The dependencies are resolved from the Artifactory server and repository configured bynpm-config命令。
jf npm install --build-name=my-build-name --build-number=1
Example 2
The following example installs the dependencies. The dependencies are resolved from the Artifactory server and repository configured bynpm-config命令。
jf npm install
Example 3
The following example installs the dependencies using the npm-ci command. The dependencies are resolved from the Artifactory server and repository configured bynpm-config命令。
jf npm ci
Publishing the Npm Packages into Artifactory
Thenpm-publishcommand packs and deploys the npm package to the designated npm repository.
Before running the npm-publish command on a project for the first time, the project should be configured using thenpm-config命令。This configuration includes the Artifactory server and repository to which the package should deployed.
If your npm package includes theprepublishorpostpublishscripts, please refer to the guidelines above.
The following table lists the command arguments and flags:
Command-name |
npm publish |
Abbreviation |
|
Command options |
|
--build-name |
[Optional] Build name. For more details, please refer toBuild Integration。 |
--build-number |
[Optional] Build number. For more details, please refer toBuild Integration。 |
| --project | [Optional] JFrog project key. |
| --module | [Optional] Optional module name for the build-info. |
| --detailed-summary | [Default: false] Set true to include a list of the affected files as part of the command output summary. |
| --scan | [Default: false] Set if you'd like all files to be scanned by Xray on the local file system prior to the upload, and skip the upload if any of the files are found vulnerable. |
| --format | [Default: table] Should be used with the --scan option. Defines the scan output format. Accepts table or json as values. |
Command argument |
The command accepts the same arguments and options that thenpm packcommand expects. |
Example
To pack and publish the npm package and also record it locally as part of buildmy-build-name/1, run the following command.The build-info can later be published to Artifactory using thebuild-publish命令。The package is published to the Artifactory server and repository configured bynpm-config命令。
jf npm publish --build-name=my-build-name --build-number=1
Building Npm Packages Using the Yarn Client
JFrog CLI provides full support for building npm packages using the yarn client. This allows you to resolve npm dependencies,while collecting build-info and storing it in Artifactory.You can download npm packages from any npm repository type - local, remote or virtual.Publishing the packages to a local npm repository is supported through thejf rt upload命令。
Yarn version 2.4.0 and above is supported.
Setting npm repositories
Before using thejfrog yarncommand, the project needs to be pre-configured with the Artifactory server and repositories, to be used for building the project. Theyarn-configcommand should be used once to add the configuration to the project. The command should run while inside the root directory of the project. The configuration is stored by the command in the。jfrogdirectory at the root directory of the project.
Command-name |
yarn-config |
Abbreviation |
yarnc |
Command options |
|
--global |
[Optional] Set to true, if you'd like the configuration to be global (for all projects on the machine). Specific projects can override the global configuration. |
| --server-id-resolve | [Optional] Artifactory server ID for resolution. The server should configured using the 'jf c add' command. |
| --repo-resolve | [Optional] Repository for dependencies resolution. |
Command arguments |
The command accepts no arguments |
在stalling Npm Packages
Thejf yarncommands execute the yarn client, to fetches the npm dependencies from the npm repositories.
Before running thecommand on a project for the first time, the project should be configured using theyarn-config命令。
The following table lists the command arguments and flags:
Command-name |
yarn |
Command options |
|
--build-name |
[Optional] Build name. For more details, please refer toBuild Integration。 |
--build-number |
[Optional] Build number. For more details, please refer toBuild Integration。 |
| --project | [Optional] JFrog project key. |
| --module | [Optional] Optional module name for the build-info. |
| --threads | [Default: 3] Number of working threads for build-info collection. |
Command arguments |
The command accepts the same arguments and options as the yarn client. |
Examples
Example 1
The following example installs the dependencies and records them locally as part of buildmy-build-name/1。The build-info can later be published to Artifactory using thebuild-publish命令。The dependencies are resolved from the Artifactory server and repository configured byyarn-config命令。
jf yarn install --build-name=my-build-name --build-number=1
Example 2
The following example installs the dependencies. The dependencies are resolved from the Artifactory server and repository configured byyarn-config命令。
jf yarn install
建筑去包
General
JFrog CLI provides full support for building Go packages using the Go client. This allows resolving Go dependenciesfrom and publish your Go packages to Artifactory, while collecting build-info and storing it in Artifactory.
需求
JFrog CLI client version 1.20.0 and above.
Artifactory version 6.1.0 and above.
Go client version 1.11.0 and above.
Example project
To help you get started, you can usethis sample project on GitHub。
Setting Go repositories
Before you can use JFrog CLI to build your Go projects with Artifactory, you first need to set the resolutions and deployment repositories for the project.
Here's how you set the repositories.
- CD to the root of the Go project.
- Run thejf rt go-config命令。
Command-name |
go-config |
Abbreviation |
|
Command options |
|
| --global | [Default false] Set to true, if you'd like the configuration to be global (for all projects on the machine). Specific projects can override the global configuration. |
| --server-id-resolve | [Optional] Artifactory server ID for resolution. The server should configured using the 'jf c add' command. |
| --server-id-deploy | [Optional] Artifactory server ID for deployment. The server should be configured using the 'jf c add' command. |
| --repo-resolve | [Optional] Repository for dependencies resolution. |
| --repo-deploy | [Optional] Repository for artifacts deployment. |
Examples
Example 1
Set repositories for for this go project.
jf go-config
Example 2
Set repositories for for all go projects on this machine.
jf go-config --global
Running Go commands
Thegocommand triggers the go client.
Before running thegocommand on a project for the first time, the project should be configured using thego-config命令。
The following table lists the command arguments and flags:
Command-name |
go |
Abbreviation |
go |
Command options |
|
| --build-name | [Optional] Build name. For more details, please refer toBuild Integration。 |
| --build-number | [Optional] Build number. For more details, please refer toBuild Integration。 |
| --project | [Optional] JFrog project key. |
| --no-fallback | [Default: false] Set to avoid downloading packages from the VCS, if they are missing in Artifactory. |
| --module | [Optional] Optional module name for the build-info. |
Command arguments |
|
Go command |
The command accepts the same arguments and options as the go client. |
Examples
Example 1
The following example runs Go build command. The dependencies resolved from Artifactory via the go-virtual repository.
Before using this example, please make sure to set repositories for the Go project using the go-config command.
jf rt go build
Example 2
The following exampleruns Go build command, while recording the build-info locally under build namemy-buildand build number1。The build-info can later be published to Artifactory using thebuild-publish命令。
Before using this example, please make sure to set repositories for the Go project using the go-config command.
jf rt go build --build-name=my-build --build-number=1
Publishing Go Packages to Artifactory
Thego-publishcommand packs and deploys the Go package to the designated Go repository in Artifactory.
Before running thego-publishcommand on a project for the first time, the project should be configured using thego-config命令。
The following table lists the command arguments and flags:
Command-name |
go-publish |
Abbreviation |
gp |
Command options |
|
--build-name |
[Optional] Build name. For more details, please refer toBuild Integration。 |
--build-number |
[Optional] Build number. For more details, please refer toBuild Integration。 |
| --project | [Optional] JFrog project key. |
| --module | [Optional] Optional module name for the build-info. |
| --detailed-summary | [Default: false] Set true to include a list of the affected files as part of the command output summary. |
Command argument |
|
| Version | The version of the Go project that is being published |
Examples
Example 1
To pack and publish the Go package, run the following command. Before running this command on a project for the first time, the project should be configured using thego-config命令。
jf gp v1.2.3
Example 2
To pack and publish the Go package and also record the build-info as part of buildmy-build-name/1, run the following command.The build-info can later be published to Artifactory using thebuild-publish命令。Before running this command on a project for the first time, the project should be configured using thego-config命令。
jf gp v1.2.3 --build-name=my-build-name --build-number=1
Building Python Packages
JFrog CLI provides full support for building Python packages using thepipandpipenvand poetry package installers. This allows resolving python dependenciesfrom Artifactory, while recording the downloaded packages. The downloaded packages are stored as dependencies in the build-info stored in Artifactory.
Once the packages are installed, the Python project can be then built and packaged using the the pip, pipenv or poetry clients. Once built, the produced artifacts can be uploaded to Artifactory using JFrog CLI's upload command and registered as artifacts in the build-info.
Example projects
To help you get started, you can usethe sample projects on GitHub。
Setting Python repository
Before you can use JFrog CLI to build your Python projects with Artifactory, you first need to set the repository for the project.
Here's how you set the repositories.
- CD to the root of the Python project.
- Run thejf pip-config,jf pipenv-config or jf poetry-config commands, depending on whether you're using the pip or pipenv clients.
Command-name |
pip-config / pipenv-config / poetry-config |
Abbreviation |
pipc / pipec / poc |
Command options |
|
| --global | [Default false] Set to true, if you'd like the configuration to be global (for all projects on the machine). Specific projects can override the global configuration. |
| --server-id-resolve | [Optional] Artifactory server ID for resolution. The server should configured using the 'jf c add' command. |
| --repo-resolve | [Optional] Repository for dependencies resolution. |
Examples
Example 1
Set repositories for this Python project when using the pip client.
jf pipc
Example 2
Set repositories for all Python projects using the pip client on this machine.
jf pipc --global
Example 3
Set repositories for this Python project when using the pipenv client.
jf pipec
Example 4
Set repositories for all Python projects using the poetry client on this machine.
jf poc --global
Example 5
Set repositories for this Python project when using the poetry client.
jf poc
Example 6
Set repositories for all Python projects using the pipenv client on this machine.
jf pipec --global
在stalling Python packages
Thepip install,pipenv installandpoetry installcommands use thepip,pipenvandpoetryclients respectively, to install the project dependencies from Artifactory. The commands can also record these packages as build dependencies as part of the build-info published to Artifactory.
Before running thepip install,pipenv installandpoetry installcommands on a project for the first time, the project should be configured using thepip-config,pipenv-confiogorpoetry-configcommands respectively.
Recording all dependencies
JFrog CLI records the installed packages as build-info dependencies. The recorded dependencies are packages installed during the 'jf rt pip-install' command execution. When running the command inside a Python environment, which already has some of the packages installed, theinstalled packages will not be included as part of the build-info, because they were not originally installed by JFrog CLI.A warning message will be added to the log in this case.
How to include all packages in the build-info?
The details of all the installed packages are always cached by thejf pip install andjf pipenv installcommand in the。jfrog/projects/deps.cache.jsonfile, located under the root of the project. JFrog CLI uses this cache for including previously installed packages in the build-info.
If the Python environment had some packages installed prior to the first execution of the install command, those previously installed packages will be missing from the cache and therefore will not be included in the build-info.
运行安装命令与“no-cache-dir' and 'force-reinstall' pip options, should re-download and install these packages, and they will therefore be included in the build-info and added to the cache. It is also recommended to run the command from inside avirtual environment。
Command-name |
pip / pipenv / poetry |
Abbreviation |
|
Command options |
|
--build-name |
[Optional] Build name. For more details, please refer toBuild Integration。 |
--build-number |
[Optional] Build number. For more details, please refer toBuild Integration。 |
| --project | [Optional] JFrog project key. |
| --module | [Optional] Optional module name for the build-info. |
Command argument |
|
Pip arguments |
Arguments and options for the pip-install command. |
Examples
Example 1
The following command triggers pip install, while recording the build dependencies as part of build namemy-buildand build number1。
jf pip install . --build-name my-build --build-number 1
Example 2
The following command triggers pipenv install, while recording the build dependencies as part of build namemy-buildand build number1。
jf pipenv install . --build-name my-build --build-number 1
Example 3
The following are command triggers poetry install, while recording the build dependencies as part of build namemy-buildand build number1。
jf poetry install . --build-name my-build --build-number 1
Building NuGet Packages
JFrog CLI provides full support for restoring NuGet packages using theNuGet client or the .NET Core CLI. This allows you to resolve NuGet dependenciesfrom and publish your NuGet packages to Artifactory, while collecting build-info and storing it in Artifactory.
NuGet dependencies resolution is supported by thejf rt nugetcommand, which uses the NuGet client or thejf rt dotnetcommand, which uses the .NET Core CLI.
To publish your NuGet packages to Artifactory, use thejf rt upload命令。
Setting NuGet repositories
Before using using thenugetordotnetcommands, the project needs to be pre-configured with the Artifactory server and repository, to be used for building the project.
Before using the nuget or dotnet commands, thenuget-configordotnet-configcommands should be used respectively. These commands configure the project with the details of the Artifactory server and repository, to be used for the build.Thenuget-configordotnet-configcommands should be executed while inside the root directory of the project. The configuration is stored by the command in the。jfrogdirectory at the root directory of the project. You then have the option of storing the .jfrog directory with the project sources, or creating this configuration after the sources are checked out.
The following table lists the commands' options:
Command-name |
nuget-config / dotnet-config |
Abbreviation |
nugetc / dotnetc |
Command options |
|
--global |
[Optional] Set to true, if you'd like the configuration to be global (for all projects on the machine). Specific projects can override the global configuration. |
| --server-id-resolve | [Optional] Artifactory server ID for resolution. The server should configured using the 'jf c add' command. |
| --repo-resolve | [Optional] Repository for dependencies resolution. |
--nuget-v2 |
[Default: false] |
Command arguments |
The command accepts no arguments |
Running Nuget and Dotnet commands
Thenugetcommand runs theNuGet clientand thedotnetcommand runs the。NET Core CLI。
Before running thenugetcommand on a project for the first time, the project should be configured using thenuget-config命令。
Before running thedotnetcommand on a project for the first time, the project should be configured using thedotnet-config命令。
The following table lists the commands arguments and options:
Command-name |
nuget / dotnet |
Abbreviation |
|
Command options |
|
--build-name |
[Optional] Build name. For more details, please refer toBuild Integration。 |
--build-number |
[Optional] Build number. For more details, please refer toBuild Integration。 |
| --project | [Optional] JFrog project key. |
| --module | [Optional] Optional module name for the build-info. |
Command argument |
The command accepts the same arguments and options as the NuGet client / .NET Core CLI. |
Examples
Example 1
Run nuget restore for the solution at the current directory, while resolving the NuGet dependencies from the pre-configured Artifactory repository. Use the NuGet client for this command
jf nuget restore
Example 2
Run dotnet restore for the solution at the current directory, while resolving the NuGet dependencies from the pre-configured Artifactory repository. Use the .NET Core CLI for this command
jf dotnet restore
Example 3
Run dotnet restore for the solution at the current directory, while resolving the NuGet dependencies from the pre-configured Artifactory repository.
在addition, record the build-info as part of buildmy-build-name/1。The build-info can later be published to Artifactory using thebuild-publishcommand:
jf dotnet restore --build-name=my-build-name --build-number=1
Packaging and Publishing Terraform Modules
JFrog CLI supports packaging Terraform modules and publishing them to a Terraform repository in Artifactory using thejf terraform publish命令。
We recommend usingthis example project on GitHubfor an easy start up.
Before using thejf terraform publishcommand for the first time, you first need to configure the Terraform repository for your Terraform project. To do this, follow these steps:
- 'cd' into the root directory for your Terraform project.
- Run the interactivejf terraform-configcommand and set deployment repository name.
Thejf terraform-configcommand will store the repository name inside the。jfrogdirectory located in the current directory. You can also add the--globalcommand option, if you prefer the repository configuration applies to all projects on the machine. In that case, the configuration will be saved in JFrog CLI's home directory.
The following table lists the command options:
Command-name |
terraform-config |
Abbreviation |
tfc |
Command options |
|
--global |
[Optional] Set to true, if you'd like the configuration to be global (for all projects on the machine). Specific projects can override the global configuration. |
| --server-id-deploy | [Optional] Artifactory server ID for deployment. The server should configured using the 'jf c add' command. |
| --repo-deploy | [Optional] Repository for artifacts deployment. |
Command arguments |
The command accepts no arguments |
Examples
Example 1
Configuring the Terraform repository for a project, while inside the root directory of the project
jf tfc
Example 2
Configuring the Terraform repository for all projects on the machine
jf tfc --global
Theterraform publishcommand creates a terraform package for the module in the current directory, and publishes it to the configured Terraform repository in Artifactory.
The following table lists the commands arguments and options:
Command-name |
terraform publish |
Abbreviation |
tf p |
Command options |
|
--namespace |
[Mandatory] Terraform module namespace |
| --provider | [Mandatory] Terraform module provider |
--tag |
[Mandatory] Terraform module tag |
| --exclusions | [Optional] A list of Semicolon-separated exclude patternswildcards. Paths inside the module matching one of the patterns are excluded from the deployed package. |
| --build-name | [Optional] Build name. For more details, please refer toBuild Integration。 |
--build-number |
[Optional] Build number. For more details, please refer toBuild Integration。 |
| --project | |
Command argument |
The command accepts no arguments |
Examples
Example 1
The command creates a package for the Terraform module in the current directory, and publishes it to the Terraform repository (configured by thejf tfc command) with the provides namespece, provider and tag.
摩根富林明tf p v——名称空间的例子——提供者aws——标签0.0.1
Example 2
The command creates a package for the Terraform module in the current directory, and publishes it to the Terraform repository (configured by thejf tfc command) with the provides namespace, provider and tag. The published package will not include the module paths which include eithertestorignore。
摩根富林明tf p v——名称空间的例子——提供者aws——标签0.0.1 --exclusions "*test*;*ignore*"
Example 3
The command creates a package for the Terraform module in the current directory, and publishes it to the Terraform repository (configured by thejf tfccommand) with the provides namespece, provider and tag. The published module will be recorded as an artifact of a build namedmy-buildwith build number1。Thejf rt bpcommand publishes the build to Artifactory.
摩根富林明tf p v——名称空间的例子——提供者aws——标签0.0.1 --build-name my-build --build-number 1 jf rt bp my-build 1
Managing Users and Groups
JFrog CLI offers a set of commands for managing users and groups. You can create and delete a bulk of users, by providing a CSV file with the users' details as an input. You can also add a list of users to a group, as well as creating and deleting groups.
Creating Users
This command allows creating a bulk of users. The details of the users are provided in a CSV format file. Here's the file format.
"username","password","email" "username1","password1","john@c.com" "username2","password1","alice@c.com"
The first line in the CSV is cells' headers. It is mandatory and is used by the command to map the cell value to the users' details.
The CSV can include additional columns, with different headers, which will be ignored by the command.
Command-name |
rt用户创建 |
Abbreviation |
rt uc |
Command options |
|
--server-id |
[Optional] Artifactory server ID configured using the config command. |
--csv |
[Mandatory] Path to a CSV file with the users' details. The first row of the file should include the name,password,email headers. |
--replace |
[Optional] Set to true if you'd like existing users or groups to be replaced. |
--users-groups |
[Optional] A list of comma-separated groups for the new users to be associated to. |
Command arguments |
The command accepts no arguments |
Example
Create new users according to details defined in the path/to/users.csv file.
jf rt users-create --csv path/to/users.csv
Deleting Users
This command allows deleting a bulk of users. The command a list of usernames to delete. The list can be either provided as a comma-seperated argument, or as a CSV file, which includes one column with the usernames. Here's the CSV format.
"username" "username1" "username2" "username2"
The first line in the CSV is cells' headers. It is mandatory and is used by the command to map the cell value to the users' details.
The CSV can include additional columns, with different headers, which will be ignored by the command.
Command-name |
rt users-delete |
Abbreviation |
rt udel |
Command options |
|
--server-id |
[Optional] Artifactory server ID configured using the config command. |
--csv |
[Optional] Path to a csv file with the usernames to delete. The first row of the file is the reserved for the cells' headers. It must include the "username" header. |
Command arguments |
|
users list |
Comma-separated list of usernames to delete. If the --csv command option is used, then this argument becomes optional. |
Example 1
Delete the users according to the usernames defined in the path/to/users.csv file.
jf rt users-delete --csv path/to/users.csv
Example 2
Delete the users according with the u1, u2 and u3 usernames.
jf rt users-delete "u1,u2,u3"
Creating Groups
This command creates a new users group.
Command-name |
rt group-create |
Abbreviation |
rt gc |
Command options |
|
--server-id |
[Optional] Artifactory server ID configured using the config command. |
Command arguments |
|
group name |
The name of the group to create. |
Example
Create a new group namereviewers。
jf rt group-create reviewers
添加用户到组
This command adds a list fo existing users to a group.
Command-name |
rt group-add-users |
Abbreviation |
rt gau |
Command options |
|
--server-id |
[Optional] Artifactory server ID configured using the config command. |
Command arguments |
|
group name |
The name of the group to add users to. |
users list |
Comma-seperated list of usernames to add to the specified group. |
Example
Add to group reviewers the users with the following usernames: u1, u2 and u3.
jf rt group-add-users "reviewers" "u1,u2,u3"
Deleting Groups
This command deletes a group.
Command-name |
rt group-delete |
Abbreviation |
rt gdel |
Command options |
|
--server-id |
[Optional] Artifactory server ID configured using the config command. |
Command arguments |
|
group name |
The name of the group to delete. |
Example
Delete thereviewersgroup.
jf rt group-delete "reviewers"
Managing Repositories
JFrog CLI offers a set of commands for managing Artifactory repositories. You can create, update and delete repositories. To make it easier to manage repositories, the commands which create and update the repositories accept a pre-defined configuration template file. This template file can also include variables. which can be later replaced with values, when creating or updating the repositories. The configuration template file is created using thejf rt repo-template命令。
Creating or Configuration Template
This is an interactive command, which creates a configuration template file. This file should be used as an argument for thejf rt repo-createor thejf rt repo-updatecommands.
When using this command to create the template, you can also provide replaceable variable, instead of fixes values. Then when the template is used to create or update repositories, values can be provided to replace the variables in the template.
Command-name |
rt repo-template |
Abbreviation |
rt rpt |
Command options |
The command has no options. |
Command arguments |
|
template path |
Specifies the local file system path for the template file created by the command. The file should not exist. |
Example
Create a configuration template, with a variable for the repository name. Then, create a repository using this template, and provide repository name to replace the variable.
$ jf rt repo-template template.json Select the template type (press Tab for options): create Insert the repository key > ${repo-name} Select the repository class (press Tab for options): local Select the repository's package type (press Tab for options): generic You can type ":x" at any time to save and exit. Select the next configuration key (press Tab for options): :x [Info] Repository configuration template successfully created at template.json. $ $ jf rt repo-create template.json --vars "repo-name=my-repo" [Info] Creating local repository... [Info] Done creating repository.
Creating / Updating Repositories
These two commands create a new repository and updates an existing a repository. Both commands accept as an argument a configuration template, which can be created by thejf rt repo-template命令。The template also supports variables, which can be replaced with values, provided when it is used.
Command-name |
rt repo-create / rt repo-update |
Abbreviation |
rt rc / rt ru |
Command options |
|
--server-id |
[Optional] Artifactory server ID configured using the config command. |
| --vars | [Optional] 列表of variables in the form of "key1=value1;key2=value2;..." to be replaced in the template. In the template, the variables should be used as follows: ${key1}. |
Command arguments |
|
template path |
Specifies the local file system path for the template file to be used for the repository creation. The template can be created using the "jf rt rpt" command. |
Example 1
Create a repository, using thetemplate.jsonfile previously generated by therepo-template命令。
jf rt repo-create template.json
Example 2
Update a repository, using thetemplate.jsonfile previously generated by therepo-template命令。
jf rt repo-update template.json
Example 3
Update a repository, using thetemplate.jsonfile previously generated by therepo-template命令。取代repo-name variable inside the template with a name for the updated repository.
jf rt repo-update template.json --vars "repo-name=my-repo"
Deleting Repositories
This command permanently deletes a repository, including all of its content.
rt repo-delete |
|
Abbreviation |
rt rdel |
Command options |
|
--server-id |
[Optional] Artifactory server ID configured using the config command. |
| --quiet | [Default: $CI] Set to true to skip the delete confirmation message. |
Command arguments |
|
repository key |
Specifies the repositories that should be removed. You can use wildcards to specify multiple repositories. |
Example
Delete a repository from Artifactory.
jf rt repo-delete generic-local
Managing Replications
JFrog CLI offers commands creating and deleting replication jobs in Artifactory. To make it easier to create replication jobs, the commands which creates the replication job accepts a pre-defined configuration template file. This template file can also include variables. which can be later replaced with values, when creating the replication job. The configuration template file is created using thejf rt replication-template命令。
Creating a Configuration Template
This command creates a configuration template file, which should be used as an argument for thejf rt replication-create命令。
When using this command to create the template, you can also provide replaceable variable, instead of fixes values. Then when the template is used to create replication jobs, values can be provided to replace the variables in the template.
Command-name |
rt replication-template |
Abbreviation |
rt rplt |
Command options |
The command has no options. |
Command arguments |
|
template path |
Specifies the local file system path for the template file created by the command. The file should not exist. |
Example
Create a configuration template, with two variables for the source and target repositories. Then, create a replication job using this template, and provide source and target repository names to replace the variables.
$ jf rt rplt template.json Select replication job type (press Tab for options): push Enter source repo key > ${source} Enter target repo key > ${target} Enter target server id (press Tab for options): my-server-id Enter cron expression for frequency (for example, 0 0 12 * * ? will replicate daily) > 0 0 12 * * ? You can type ":x" at any time to save and exit. Select the next property > :x [Info] Replication creation config template successfully created at template.json. $ $ jf rt rplc template.json --vars "source=generic-local;target=generic-local" [Info] Done creating replication job.
Creating Replication Jobs
This command creates a new replication job for a repository. The command accepts as an argument a configuration template, which can be created by thejf rt replication-template命令。The template also supports variables, which can be replaced with values, provided when it is used.
Command-name |
replication-create |
Abbreviation |
rt rplc |
Command options |
|
--server-id |
[Optional] Artifactory server ID configured using the config command. |
| --vars | [Optional] 列表of variables in the form of "key1=value1;key2=value2;..." to be replaced in the template. In the template, the variables should be used as follows: ${key1}. |
Command arguments |
|
template path |
Specifies the local file system path for the template file to be used for the replication job creation. The template can be created using the "jf rt rplt" command. |
Example 1
Create a replication job, using thetemplate.jsonfile previously generated by thereplication-template命令。
jf rt rplc template.json
Example 2
Update a replication job, using thetemplate.jsonfile previously generated by thereplication-template命令。取代sourceandtargetvariables inside the template with the names of the replication source and target reposities.
jf rt rplc template.json --vars "source=my-source-repo;target=my-target-repo"
Deleting Replication jobs
This command permanently deletes a replication jobs from a repository.
rt replication-delete |
|
Abbreviation |
rt rpldel |
Command options |
|
--server-id |
[Optional] Artifactory server ID configured using the config command. |
| --quiete | [Default: $CI] Set to true to skip the delete confirmation message. |
Command arguments |
|
repository key |
The repository from which the replications will be deleted. |
Example
Delete a repository from Artifactory.
jf rt rpldel my-repo-name
Managing Permission Targets
JFrog CLI offers commands creating, updating and deleting permission targets in Artifactory. To make it easier to create and update permission targets, the commands which create and update the permission targets accept a pre-defined configuration template file. This template file can also include variables. which can be later replaced with values, when creating or updating the permission target. The configuration template file is created using thejf rt permission-target-template命令。
Creating a Configuration Template
This command creates a configuration template file, which should be used as an argument for thejf rt permission-target-createandjf rt permission-target-updatecommands.
Command-name |
rt permission-target-template |
Abbreviation |
rt ptt |
Command options |
The command has no options. |
Command arguments |
|
template path |
Specifies the local file system path for the template file created by the command. The file should not exist. |
Creating / Updating Permission Targets
This command creates a new permission target. The command accepts as an argument a configuration template, which can be created by thejf rt permission-target-template命令。The template also supports variables, which can be replaced with values, provided when it is used.
Command-name |
permission-target-create / permission-target-update |
Abbreviation |
rt ptc / rt ptu |
Command options |
|
--server-id |
[Optional] Artifactory server ID configured using the config command. |
| --vars | [Optional] 列表of variables in the form of "key1=value1;key2=value2;..." to be replaced in the template. In the template, the variables should be used as follows: ${key1}. |
Command arguments |
|
template path |
Specifies the local file system path for the template file to be used for the permission target creation or update. The template can be created using the "jf rt ptt" command. |
Deleting Permission Targets
This command permanently deletes a permission target.
rt permission-target-delete |
|
Abbreviation |
rt ptdel |
Command options |
|
--server-id |
[Optional] Artifactory server ID configured using the config command. |
| --quiete | [Default: $CI] Set to true to skip the delete confirmation message. |
Command arguments |
|
permission target name |
Thepermission target that should be removed. |
Using File Specs
To achieve complex file manipulations you may require several CLI commands. For example, you may need to upload several different sets of files to different repositories. To simplify the implementation of these complex manipulations, you can apply JFrog CLIdownload,上传,move, copyanddeletecommands with JFrog Artifactory using--specoption to replace the inline command arguments and options. Similarly, you cancreate and update release bundlesby providing the--speccommand option. Each command uses an array of file specifications in JSON format with a corresponding schema as described in the sections below. Note that if any of these commands are issued using both inline options as well as the file specs, then the inline options override their counterparts specified in the file specs.
File Spec Schemas
Copy and Move Commands Spec Schema
The file spec schema for the copy and move commands is as follows:
{ "files": [ { "pattern" or "aql": "[Mandatory]", "target": "[Mandatory]", "props": "[Optional]", "excludeProps": "[Optional]", "recursive": "[Optional, Default: 'true']", "flat" : "[Optional, Default: 'false']", "exclusions": ["[Optional, Applicable only when 'pattern' is specified]"], "archiveEntries": "[Optional]", "build": "[Optional]", "bundle": "[Optional]", "validateSymlinks": "[Optional]", "sortBy" : ["[Optional]"], "sortOrder": "[Optional, Default: 'asc']", "limit": [Optional], "offset": [Optional] } ] }
Download Command Spec Schema
The file spec schema for the download command is as follows:
{ "files": [ { "pattern" or "aql": "[Mandatory]", "target": "[Optional]", "props": "[Optional]", "excludeProps": "[Optional]", "recursive": "[Optional, Default: 'true']", "flat" : "[Optional, Default: 'false']", "exclusions": ["[Optional, Applicable only when 'pattern' is specified]"], "archiveEntries": "[Optional]", "build": "[Optional]", "bundle": "[Optional]", "sortBy" : ["[Optional]"], "sortOrder": "[Optional, Default: 'asc']", "limit": [Optional], "offset": [Optional] } ] }
Create and Update Release Bundle Commands Spec Schema
The file spec schema for the create amd update release bundle commands is as follows:
{ "files": [ { "pattern" or "aql": "[Mandatory]", "target": "[Optional]", "props": "[Optional]", "targetProps": "[Optional]", "excludeProps": "[Optional]", "recursive": "[Optional, Default: 'true']", "flat" : "[Optional, Default: 'false']", "exclusions": ["[Optional, Applicable only when 'pattern' is specified]"], "archiveEntries": "[Optional]", "build": "[Optional]", "bundle": "[Optional]", "sortBy" : ["[Optional]"], "sortOrder": "[Optional, Default: 'asc']", "limit": [Optional], "offset": [Optional] } ] }
Upload Command Spec Schema
The file spec schema for the upload command is as follows:
{ "files": [ { "pattern": "[Mandatory]", "target": "[Mandatory]", "targetProps": "[Optional]", "recursive": "[Optional, Default: 'true']", "flat" : "[Optional, Default: 'true']", "regexp": "[Optional, Default: 'false']", "ant": "[Optional, Default: 'false']", "archive": "[Optional, Must be: 'zip']", "exclusions": ["[Optional]"] } ] }
Search, Set-Props and Delete Commands Spec Schema
The file spec schema for the search and delete commands are as follows:
{ "files": [ { "pattern" or "aql": "[Mandatory]", "props": "[Optional]", "excludeProps": "[Optional]", "recursive": "[Optional, Default: 'true']", "exclusions": ["[Optional, Applicable only when 'pattern' is specified]"], "archiveEntries": "[Optional]", "build": "[Optional]", "bundle": "[Optional]", "sortBy" : ["[Optional]"], "sortOrder": "[Optional, Default: 'asc']", "limit": [Optional], "offset": [Optional] } ] }
Examples
The following examples can help you get started using File Specs.
Example 1:
Download all files located under theall-my-frogsdirectory in themy-local-reporepository to thefroggydirectory.
{ "files": [ { "pattern": "my-local-repo/all-my-frogs/", "target": "froggy/" } ] }
Example 2:
Download all files located under theall-my-frogsdirectory in themy-local-reporepository to thefroggydirectory. Download only files which are artifacts of build number 5 of buildmy-build。
{ "files": [ { "pattern": "my-local-repo/all-my-frogs/", "target": "froggy/", "build": "my-build/5" } ] }
Example 3:
Download all files retrieved by the AQL query to thefroggydirectory.
{ "files": [ { "aql": { "items.find": { "repo": "my-local-repo", "$or": [ { "$and": [ { "path": { "$match": "." }, "name": { "$match": "a1.in" } } ] }, { "$and": [ { "path": { "$match": "*" }, "name": { "$match": "a1.in" } } ] } ] } }, "target": "froggy/" } ] }
Example 4: Upload
All zip files located under the
2022世界杯阿根廷预选赛赛程directory to thezipfolder, under theall-my-frogsrepository.AND
All TGZ files located under the
2022世界杯阿根廷预选赛赛程directory to thetgzfolder, under theall-my-frogsrepository.Tag all zip files with type = zip and status = ready.
Tag all tgz files with type = tgz and status = ready.
{ "files": [ { "pattern": "resources/*.zip", "target": "all-my-frogs/zip/", "props": "type=zip;status=ready" }, { "pattern": "resources/*.tgz", "target": "all-my-frogs/tgz/", "props": "type=tgz;status=ready" } ] }
Example 5:
Upload all zip files located under the2022世界杯阿根廷预选赛赛程directory to thezipfolder, under theall-my-frogsrepository.
{ "files": [ { "pattern": "resources/*.zip", "target": "all-my-frogs/zip/" } ] }
Example 6:
Package all files located (including sub-directories) under the2022世界杯阿根廷预选赛赛程directory into a zip archive namedarchive.zip, and upload it into the root of theall-my-frogsrepository.
{ "files": [ { "pattern": "resources/", "archive": "zip", "target": "all-my-frogs/" } ] }
Example 7:
Download all files located under theall-my-frogsdirectory in themy-local-reporepositoryexceptfor files with .txt extension and all files inside theall-my-frogsdirectory with the props. prefix.
Notice that the exclude patterns do not include the repository.
{ "files": [ { "pattern": "my-local-repo/all-my-frogs/", "exclusions": ["*.txt","all-my-frog/props.*"] } ] }
Example 8:
Download The latest file uploaded to theall-my-frogsdirectory in themy-local-reporepository.
{ "files": [ { "pattern": "my-local-repo/all-my-frogs/", "target": "all-my-frogs/files/", "sortBy": ["created"], "sortOrder": "desc", "limit": 1 } ] }
Example 9:
Search for the three largest files located under theall-my-frogsdirectory in themy-local-reporepository. If there are files with the same size, sort them "internally" by creation date.
{ "files": [ { "pattern": "my-local-repo/all-my-frogs/", "sortBy": ["size","created"], "sortOrder": "desc", "limit": 3 } ] }
Example 10:
Download The second latest file uploaded to theall-my-frogsdirectory in themy-local-reporepository.
{ "files": [ { "pattern": "my-local-repo/all-my-frogs/", "target": "all-my-frogs/files/", "sortBy": ["created"], "sortOrder": "desc", "limit": 1, "offset": 1 } ] }
Example 11:
This example shows how todelete artifacts in artifactory under specified path based on how old they are。
The following File Spec finds all the folders which match the following criteria:
- 他们是我下-repo repository.
- They are inside a folder with a name that matches abc-*-xyz and is located at the root of the repository.
- Their name matches ver_*
- They were created more that 7 days ago.
{ "files": [ { "aql": { "items.find": { "repo": "myrepo", "path": {"$match":"abc-*-xyz"}, "name": {"$match":"ver_*"}, "type": "folder", "$or": [ { "$and": [ { "created": { "$before":"7d" } } ] } ] } } } ] }
Example 12
This example usesplaceholders。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 a folder in Artifactory).
{ "files": [ { "pattern": "(*).tgz", "target": "my-local-repo/{1}/", } ] }
Example 13
This examples usesplaceholders。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.
{ "files": [ { "pattern": "(frog*)", "target": "my-local-repo/frogfiles/{1}-up", "recursive": "false" } ] }
Example 14
以下两个例子导致相同outcome.
The first one usesplaceholders, while the second one does not. Both examples download all files from the generic-local repository to be under the my/local/path/ local file-system path, while maintaining the original Artifactory folder hierarchy. Notice the different flat values in the two examples.
{ "files": [ { "pattern": "generic-local/{*}", "target": "my/local/path/{1}", "flat": "true" } ] } { "files": [ { "pattern": "generic-local/", "target": "my/local/path/", "flat": "false" } ] }
Schema Validation
JSON schemasallow you to annotate and validate JSON files. The JFrog File Spec schema is available in theJSON Schema Storecatalog and in the following link:https://github.com/jfrog/jfrog-cli/blob/v2/schema/filespec-schema.json。
Using Jetbrains IDEs (Intellij IDEA, Webstorm, Goland, etc...)?
The File Spec schema automatically applied on the following file patterns:
**/filespecs/*.json
*filespec*.json
*.filespec
Using Visual Studio Code?
To apply the File Spec schema validation, install theJFrog VS-Code extension。
另外,复制下面的设置。json file:
settings.json
“json。模式”:[{“fileMatch”:[" * * /文件规范/ *。json", "*filespec*.json", "*.filespec"], "url": "https://raw.githubusercontent.com/jfrog/jfrog-cli/v2/schema/filespec-schema.json" } ]
Downloading the Maven and Gradle Extractor JARs
For integrating with Maven and Gradle, JFrog CLI uses the build-info-extractor jars files. These jar files are downloaded by JFrog CLI from jcenter the first time they are needed.
If you're using JFrog CLI on a machine which has no access to the internet, you can configure JFrog CLI to download these jar files from an Artifactory instance. Here's how to configure Artifactory and JFrog CLI to download the jars files.
Create a remote Maven repository in Artifactory and name itextractors。When creating the repository, configure it to proxyhttps://releases.jfrog.io/artifactory/oss-release-local
Make sure that this Artifactory server is known to JFrog CLI, using thejfrog c show命令。If not, configure it using thejfrog c add命令。
Set theJFROG_CLI_EXTRACTORS_REMOTEenvironment 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 examplemy-rt-server/extractors
Overview
Content Tools
JFrog.com|Documentation|Featured| Have a question? Want to report an issue?Contact JFrog support