From 267afa18fa040669a1fa5f2256f8e26589a4988e Mon Sep 17 00:00:00 2001 From: Michael Sverdlov Date: Sun, 14 Apr 2024 18:08:45 +0300 Subject: [PATCH 1/9] fix docs --- .../artifactory-gradle-plugin.md | 4 +- .../ci-integrations/github-actions.md | 6 +- .../gitlab-templates-for-jfrog.md | 2 +- .../maven-artifactory-plugin.md | 14 +- .../authentication.md | 10 +- .../build-integration.md | 38 +- .../curl-integration.md | 2 +- .../environment-variables.md | 28 +- .../generic-files.md | 266 ++++++------- .../cli-for-jfrog-artifactory/git-lfs.md | 2 +- .../managing-configuration-entities.md | 28 +- .../package-managers-integration.md | 354 +++++++++--------- .../verifying-artifactory-accessibility.md | 2 +- .../jfrog-cli/cli-for-jfrog-cloud-transfer.md | 6 +- .../jfrog-cli/cli-for-jfrog-curation.md | 2 +- .../jfrog-cli/cli-for-jfrog-distribution.md | 10 +- .../jfrog-cli/cli-for-jfrog-pipelines.md | 12 +- .../cli-for-jfrog-security/README.md | 2 +- .../scan-published-builds.md | 2 +- .../scan-your-binaries.md | 4 +- .../scan-your-source-code.md | 6 +- .../jfrog-cli/cli-plugins/README.md | 2 +- .../jfrog-cli/cli-plugins/developer-guide.md | 2 +- 23 files changed, 402 insertions(+), 402 deletions(-) diff --git a/jfrog-applications/ci-and-sdks/ci-integrations/artifactory-gradle-plugin.md b/jfrog-applications/ci-and-sdks/ci-integrations/artifactory-gradle-plugin.md index 801b338..2ce5346 100644 --- a/jfrog-applications/ci-and-sdks/ci-integrations/artifactory-gradle-plugin.md +++ b/jfrog-applications/ci-and-sdks/ci-integrations/artifactory-gradle-plugin.md @@ -23,8 +23,8 @@ The plugin adds the `artifactoryPublish` task for each project, in the 'publishi * The below convention attributes have been removed: | Attribute | Migration action | - | :-------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | - | parent | No longer supported. | + |:---------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | parent | No longer supported. | | resolve | To define the Artifactory resolution repositories for your build, declare the repositories under the repositories section as described [here](https://docs.gradle.org/current/userguide/declaring\_repositories.html#declaring-repositories). | diff --git a/jfrog-applications/ci-and-sdks/ci-integrations/github-actions.md b/jfrog-applications/ci-and-sdks/ci-integrations/github-actions.md index 7b7ca45..13e828e 100644 --- a/jfrog-applications/ci-and-sdks/ci-integrations/github-actions.md +++ b/jfrog-applications/ci-and-sdks/ci-integrations/github-actions.md @@ -6,7 +6,7 @@ This GitHub Action downloads, installs and configures JFrog CLI, so that it can In addition, the Action includes the following features, when using JFrog CLI to work with JFrog Platform. -* The connection details of the JFrog platform used by JFrog CLI can be stored as secrets. Read more about it [here](broken-reference). +* The connection details of the JFrog platform used by JFrog CLI can be stored as secrets. * There's no need to add the _build name_ and _build number_ options and arguments to commands which accept them. All build related operations will be automatically recorded with the _Workflow Name_ as build name and _Run Number_ as build number. ## Usage @@ -52,7 +52,7 @@ You can use these environment variables in your workflow as follows: ``` | Important: If both Config Token(JF\_ENV\_\*) and separate environment variables(JF\_URL, ...) are provided, the default config will be the Config Token. To make the above separate environment variables as the default config use `jf c use setup-jfrog-cli-server` | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| #### Storing the connection details using single Config Token @@ -93,7 +93,7 @@ If you have multiple Config Tokens as secrets, you can use all of them in the wo ``` | Important: When exposing more than one JFrog configuration to the Action, you should always add the `jf c use` command to specify the server to use. | -| ---------------------------------------------------------------------------------------------------------------------------------------------------- | +|------------------------------------------------------------------------------------------------------------------------------------------------------| ### Setting the build name and build number when publishing build-info to Artifactory diff --git a/jfrog-applications/ci-and-sdks/ci-integrations/gitlab-templates-for-jfrog.md b/jfrog-applications/ci-and-sdks/ci-integrations/gitlab-templates-for-jfrog.md index e79db5f..04be35d 100644 --- a/jfrog-applications/ci-and-sdks/ci-integrations/gitlab-templates-for-jfrog.md +++ b/jfrog-applications/ci-and-sdks/ci-integrations/gitlab-templates-for-jfrog.md @@ -89,7 +89,7 @@ As shown in the above [Including the Script](broken-reference) and [Referencing Configurations can be done via Project Settings > CI/CD > Variables: | Variable | Usage | -| -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +|----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | JF\_DOCKER\_REGISTRY | Docker registry in Artifactory. For more info, see [Getting Started with Artifactory as a Docker Registry](https://www.jfrog.com/confluence/display/JFROG/Getting+Started+with+Artifactory+as+a+Docker+Registry) | | JFROG\_CLI\_BUILD\_PROJECT | JFrog project key to be used by commands which expect build name and build number. Determines the project of the published build. | | JFROG\_CLI\_VERSION | Use a specific JFrog CLI version instead of the latest version. The minimal version allowed is: 2.17.0 | diff --git a/jfrog-applications/ci-and-sdks/ci-integrations/maven-artifactory-plugin.md b/jfrog-applications/ci-and-sdks/ci-integrations/maven-artifactory-plugin.md index dab31eb..9e9ed46 100644 --- a/jfrog-applications/ci-and-sdks/ci-integrations/maven-artifactory-plugin.md +++ b/jfrog-applications/ci-and-sdks/ci-integrations/maven-artifactory-plugin.md @@ -50,7 +50,7 @@ A typical build plugin configuration would be as follows: ``` -The plugin's invocation phase is validate by default and we recommend you don't change it so the plugin is called as early as possible in the lifecycle of your Maven build. +The plugin's invocation phase is validate by default, and we recommend you don't change it so the plugin is called as early as possible in the lifecycle of your Maven build. #### Full Configuration @@ -114,13 +114,13 @@ However, the Maven Artifactory Plugin provides many other configurations: #### Configuration Details -| Configuration | Description | -| :------------------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Configuration | Description | +|:--------------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `` | Specifies properties you can attach to published artifacts. For example: prop-value. | -| `` | Specifies whether environment variables are published as part of BuildInfo metadata and which include or exclude patterns are applied when variables are collected | -| `` | Defines an Artifactory repository where build artifacts should be published using a combination of a `` and `/`. Build artifacts are deployed if the deploy goal is executed and only after all modules are built. | -| `` | Updates BuildInfo metadata published together with build artifacts. You can configure whether or not BuildInfo metadata is published using the configuration. | -| `` | Specifies HTTP/S proxy. | +| `` | Specifies whether environment variables are published as part of BuildInfo metadata and which include or exclude patterns are applied when variables are collected | +| `` | Defines an Artifactory repository where build artifacts should be published using a combination of a `` and `/`. Build artifacts are deployed if the deploy goal is executed and only after all modules are built. | +| `` | Updates BuildInfo metadata published together with build artifacts. You can configure whether or not BuildInfo metadata is published using the configuration. | +| `` | Specifies HTTP/S proxy. | #### Reading Environment Variables and System Properties diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/authentication.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/authentication.md index dd1d685..22f7f3d 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/authentication.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/authentication.md @@ -7,19 +7,19 @@ When used with Artifactory, JFrog CLI offers several means of authentication: JF To authenticate yourself using your JFrog login credentials, either configure your credentials once using the **jf c add** command or provide the following option to each command. | Command option | Description | -| -------------- | --------------------------------------------------------------------- | +|----------------|-----------------------------------------------------------------------| | --url | JFrog Artifactory API endpoint URL. It usually ends with /artifactory | | --user | JFrog username | | --password | JFrog password or API key | -For enhanced security, when JFrog CLI is configured to use a username and password / API key, it automatically generates an access token to authenticate with Artifactory. The generated access token is valid for one hour only. JFrog CLI automatically refreshed the token before it expires. The **jfrog c add** command allows disabling this functionality. This feature is currently not supported by commands which use external tools or package managers or work with JFrog Distribution. +For enhanced security, when JFrog CLI is configured to use a username and password / API key, it automatically generates an access token to authenticate with Artifactory. The generated access token is valid for one hour only. JFrog CLI automatically refreshed the token before it expires. The **jf c add** command allows disabling this functionality. This feature is currently not supported by commands which use external tools or package managers or work with JFrog Distribution. ## Authenticating with an Access Token To authenticate yourself using an Artifactory Access Token, either configure your Access Token once using the **jf c add** command or provide the following option to each command. | Command option | Description | -| -------------- | --------------------------------------------------------------------- | +|----------------|-----------------------------------------------------------------------| | --url | JFrog Artifactory API endpoint URL. It usually ends with /artifactory | | --access-token | JFrog access token | @@ -39,7 +39,7 @@ From version 4.4, Artifactory supports SSH authentication using RSA public and p * Configure your Artifactory URL to have the following format: `ssh://[host]:[port]` There are two ways to do this: * For each command, use the `--url` command option. - * Specify the Artifactory URL in the correct format using the **jfrog c add** command. + * Specify the Artifactory URL in the correct format using the **jf c add** command. *** @@ -52,7 +52,7 @@ From version 4.4, Artifactory supports SSH authentication using RSA public and p *** * Configure the path to your SSH key file. There are two ways to do this: * For each command, use the `--ssh-key-path` command option. - * Specify the path using the **jfrog c add** command. + * Specify the path using the **jf c add** command. ## Authenticating using Client Certificates (mTLS) diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/build-integration.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/build-integration.md index d358dcb..259cc07 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/build-integration.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/build-integration.md @@ -43,7 +43,7 @@ Environment variables are collected using the `build-collect-env` (`bce`) comman The following table lists the command arguments and flags: | | | -| ----------------- | ------------------------------------------- | +|-------------------|---------------------------------------------| | Command name | rt build-collect-env | | Abbreviation | rt bce | | Command options | | @@ -92,18 +92,18 @@ The following table lists the command arguments and flags: #### Configuration file properties -| | | -| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Property name | Description | -| Version | The schema version is intended for internal use. Do not change! | +| | | +|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Property name | Description | +| Version | The schema version is intended for internal use. Do not change! | | serverID |

Artifactory server ID configured by the 'jf config' command. The command uses this server for fetching details about previous published builds. 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 'jf config' command is 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" retrieves HAP-1007 from 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" retrieves the sample 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 the **jf rt build-promote** command. | +| 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" retrieves HAP-1007 from 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" retrieves the sample 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 the **jf rt build-promote** command. | #### Example @@ -139,7 +139,7 @@ By default, the command collects the files from the local file system. If you'd #### Commands Params | | | -| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Command name | rt build-add-dependencies | | Abbreviation | rt bad | | Command options |

Warning

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.

| @@ -194,7 +194,7 @@ jf rt bp my-build-name 18 ### Commands Params | | | -| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Command name | rt build-publish | | Abbreviation | rt bp | | Command options | | @@ -254,7 +254,7 @@ The way to do this is by using the **build-append** command. Running this comman 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. | @@ -299,7 +299,7 @@ This command is used to [promote build](https://jfrog.com/knowledge-base/how-doe ### Commands Params | | | -| ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | +|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------| | Command name | rt build-promote | | Abbreviation | rt bpr | | Command options | | @@ -320,7 +320,7 @@ This command is used to [promote build](https://jfrog.com/knowledge-base/how-doe ### Example -This example involves moving the artifacts associated with the published build-info, identified by the build name 'my-build-name' and build number '18', from their existing Artifactory repository to a new Artifactory repository called 'target-repository'." +This example involves moving the artifacts associated with the published build-info, identified by the build name 'my-build-name' and build number '18', from their existing Artifactory repository to a new Artifactory repository called 'target-repository'. ``` jf rt bpr my-build-name 18 target-repository @@ -335,7 +335,7 @@ Build-info is accumulated by the CLI according to the commands you apply until y The following table lists the command arguments and flags: | | | -| ----------------- | ---------------------------------- | +|-------------------|------------------------------------| | Command name | rt build-clean | | Abbreviation | rt bc | | Command options | The command has no options. | @@ -361,7 +361,7 @@ This command is used to discard builds previously published to Artifactory using The following table lists the command arguments and flags: | | | -| ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------- | +|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------| | Command name | rt build-discard | | Abbreviation | rt bdi | | Command options | | diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/curl-integration.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/curl-integration.md index d6681c8..352f122 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/curl-integration.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/curl-integration.md @@ -8,7 +8,7 @@ Execute a cUrl command, using the configured Artifactory details. The command ex ## Commands Params | | | | -| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | - | +|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---| | Command name | rt curl | | | Abbreviation | rt cl | | | Command options | | | diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/environment-variables.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/environment-variables.md index 979e0b8..425bd93 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/environment-variables.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/environment-variables.md @@ -3,21 +3,21 @@ Some of the Artifactory commands make use of the following environment variable: -| | | -| -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| **Variable Name** | **Description** | -| **JFROG\_CLI\_MIN\_CHECKSUM\_DEPLOY\_SIZE\_KB** |

[Default: 10]

Minimum file size in KB for which JFrog CLI performs checksum deploy optimization.

| +| | | +|----------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **Variable Name** | **Description** | +| **JFROG\_CLI\_MIN\_CHECKSUM\_DEPLOY\_SIZE\_KB** |

[Default: 10]

Minimum file size in KB for which JFrog CLI performs checksum deploy optimization.

| | **JFROG\_CLI\_RELEASES\_REPO** |

Configured Artifactory repository name to download the jar needed by the mvn/gradle command.
This environment variable's value format should be <server ID configured by the 'jf c add' command>/<repo name>.
The repository should proxy https://releases.jfrog.io.
This environment variable is used by the 'jf mvn' and 'jf gradle' commands, and also by the 'jf audit' command, when used for maven or gradle projects.

| -| **JFROG\_CLI\_DEPENDENCIES\_DIR** |

[Default: $JFROG_CLI_HOME_DIR/dependencies]

Defines the directory to which JFrog CLI's internal dependencies are downloaded.

| -| **JFROG\_CLI\_REPORT\_USAGE** |

[Default: true]

Set to false to block JFrog CLI from sending usage statistics to Artifactory.

| -| **JFROG\_CLI\_SERVER\_ID** | Server ID configured using the config command, unless sent as a command argument or option. | -| **JFROG\_CLI\_BUILD\_NAME** | Build name to be used by commands which expect a build name, unless sent as a command argument or option. | -| **JFROG\_CLI\_BUILD\_NUMBER** | Build number to be used by commands which expect a build number, unless sent as a command argument or option. | -| **JFROG\_CLI\_BUILD\_PROJECT** | JFrog project key to be used by commands that expect build name and build number. Determines the project of the published build. | -| **JFROG\_CLI\_BUILD\_URL** | Sets the CI server build URL in the build-info. The "jf rt build-publish" command uses the value of this environment variable unless the --build-url command option is sent. | -| **JFROG\_CLI\_ENV\_EXCLUDE** |

[Default: *password*;*secret*;*key*;*token*]

List of case insensitive patterns in the form of "value1;value2;...". Environment variables match those patterns will be excluded. This environment variable is used by the "jf rt build-publish" command, in case the --env-exclude command option is not sent.

| -| **JFROG\_CLI\_TRANSITIVE\_DOWNLOAD\_EXPERIMENTAL** |

[Default: false]

Used by the "jf rt download" command. Set to true to download artifacts also from remote repositories. This feature is experimental and available on Artifactory version 7.17.0 or higher.

| -| **JFROG\_CLI\_UPLOAD\_EMPTY\_ARCHIVE** |

[Default: false]

Used by the "jf rt upload" command. Set to true if you'd like to upload an empty archive when '--archive' is set but all files were excluded by exclusions pattern.

| +| **JFROG\_CLI\_DEPENDENCIES\_DIR** |

[Default: $JFROG_CLI_HOME_DIR/dependencies]

Defines the directory to which JFrog CLI's internal dependencies are downloaded.

| +| **JFROG\_CLI\_REPORT\_USAGE** |

[Default: true]

Set to false to block JFrog CLI from sending usage statistics to Artifactory.

| +| **JFROG\_CLI\_SERVER\_ID** | Server ID configured using the config command, unless sent as a command argument or option. | +| **JFROG\_CLI\_BUILD\_NAME** | Build name to be used by commands which expect a build name, unless sent as a command argument or option. | +| **JFROG\_CLI\_BUILD\_NUMBER** | Build number to be used by commands which expect a build number, unless sent as a command argument or option. | +| **JFROG\_CLI\_BUILD\_PROJECT** | JFrog project key to be used by commands that expect build name and build number. Determines the project of the published build. | +| **JFROG\_CLI\_BUILD\_URL** | Sets the CI server build URL in the build-info. The "jf rt build-publish" command uses the value of this environment variable unless the --build-url command option is sent. | +| **JFROG\_CLI\_ENV\_EXCLUDE** |

[Default: *password*;*secret*;*key*;*token*]

List of case insensitive patterns in the form of "value1;value2;...". Environment variables match those patterns will be excluded. This environment variable is used by the "jf rt build-publish" command, in case the --env-exclude command option is not sent.

| +| **JFROG\_CLI\_TRANSITIVE\_DOWNLOAD\_EXPERIMENTAL** |

[Default: false]

Used by the "jf rt download" command. Set to true to download artifacts also from remote repositories. This feature is experimental and available on Artifactory version 7.17.0 or higher.

| +| **JFROG\_CLI\_UPLOAD\_EMPTY\_ARCHIVE** |

[Default: false]

Used by the "jf rt upload" command. Set to true if you'd like to upload an empty archive when '--archive' is set but all files were excluded by exclusions pattern.

| *** diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/generic-files.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/generic-files.md index 19aaa3b..fa355e1 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/generic-files.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/generic-files.md @@ -6,42 +6,42 @@ This command is used to upload files to Artifactory. ### Commands Params -| | | -| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Command name | rt upload | -| Abbreviation | rt u | -| Command options |

Warning

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 the jf c add command. If not specified, the default configured Artifactory server is used.

| +| | | +|--------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Command name | rt upload | +| Abbreviation | rt u | +| Command options |

Warning

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 the jf c add command. If not specified, the default configured Artifactory server is used.

| | --spec |

[Optional]

Path to a file spec. For more details, please refer to Using File Specs.

| -| --spec-vars |

[Optional]

List 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}.

| +| --spec-vars |

[Optional]

List 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 to Build Integration.

| | --build-number |

[Optional]

Build number. For more details, please refer to Build Integration.

| -| --project |

[Optional]

JFrog project key.

| -| --module |

[Optional]

Optional module name for the build-info.

| -| --target-props |

[Optional]

A list of Artifactory properties specified 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".

| -| --deb |

[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.

| +| --project |

[Optional]

JFrog project key.

| +| --module |

[Optional]

Optional module name for the build-info.

| +| --target-props |

[Optional]

A list of Artifactory properties specified 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".

| +| --deb |

[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.

If Using Placeholders are used, the value of this option is ignored.

Note

JFrog CLI v1

In 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. The symlink file 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. Bottom-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 --regexp and --ant options. Please read the --regexp and --ant options 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.

| -| --min-split |

[Default: 200]

The minimum file size in MiB required to attempt a multi-part upload. This option, as well as the functionality of multi-part upload, requires Artifactory with S3 storage.

| -| --split-count |

[Default: 5]

The maximum number of parts that can be concurrently uploaded per file during a multi-part upload. Set to 0 to disable multi-part upload. This option, as well as the functionality of multi-part upload, requires Artifactory with S3 storage.

| -| Command arguments |

The command takes two arguments.

In case the --spec option is used, the commands accept no arguments.

| -| Source path | The first argument specifies the local file system path to artifacts that should be uploaded to Artifactory. You can specify multiple artifacts by using wildcards or a regular expression as designated by the **--regexp** command option. Please read the **--regexp** option description for more information. | +| --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. The symlink file 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. Bottom-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 --regexp and --ant options. Please read the --regexp and --ant options 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.

| +| --min-split |

[Default: 200]

The minimum file size in MiB required to attempt a multi-part upload. This option, as well as the functionality of multi-part upload, requires Artifactory with S3 storage.

| +| --split-count |

[Default: 5]

The maximum number of parts that can be concurrently uploaded per file during a multi-part upload. Set to 0 to disable multi-part upload. This option, as well as the functionality of multi-part upload, requires Artifactory with S3 storage.

| +| Command arguments |

The command takes two arguments.

In case the --spec option is used, the commands accept no arguments.

| +| Source path | The first argument specifies the local file system path to artifacts that should be uploaded to Artifactory. You can specify multiple artifacts by using wildcards or a regular expression as designated by the **--regexp** command option. Please read the **--regexp** option description for more information. | | Target path |

The second argument specifies the target path in Artifactory in the following format: [repository name]/[repository path]

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 to Using Placeholders.

| ### Examples @@ -71,7 +71,7 @@ jf rt u "build/*.zip" my-local-repo/zipFiles/ --sync-deletes="my-local-repo/zipF #### Example 4 -Collect all files located under the **build** directory (including subdirectories), and upload them to the \*\*my-release-local \*\*repository, under the **files** folder, while maintaining the original names of the artifacts. Exclude (do not upload) files, which include **install** as part of their path, and have the **pack** extension. This example uses a wildcard pattern. See **Example 5**, which uses regular expressions instead. +Collect all files located under the **build** directory (including subdirectories), and upload them to the **my-release-local** repository, under the **files** folder, while maintaining the original names of the artifacts. Exclude (do not upload) files, which include **install** as part of their path, and have the **pack** extension. This example uses a wildcard pattern. See **Example 5**, which uses regular expressions instead. ``` jf rt u "build/" my-release-local/files/ --exclusions="\*install\*pack*" @@ -111,49 +111,49 @@ This command is used to download files from Artifactory. ### Commands Params -| | | -| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| Command name | rt download | -| Abbreviation | rt dl | -| Command options |

Warning

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 to Build Integration.

| -| --build-number |

[Optional]

Build number. For more details, please refer to Build 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 to Using File Specs.

| -| --spec-vars |

[Optional]

List 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 Artifactory properties specified as "key=value" pairs separated by a semi-colon (for example, "key1=value1;key2=value2;key3=value3"). Only artifacts with all of the specified properties names and values will be downloaded.

| -| --exclude-props |

[Optional]

A list of Artifactory properties specified as "key=value" pairs separated by a semi-colon (for example, "key1=value1;key2=value2;key3=value3"). Only artifacts without all of 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.

If Using Placeholders are 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 --min-split in size). To download each file in a single thread, set to 0.

| -| --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 --split-count segments. Any files smaller than the specified number will be downloaded in a single thread. If set to -1, files are not split.

| -| --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.

| -| --bypass-archive-inspection |

[Default: false]

Set to true to bypass the archive security inspection before it is unarchived. Used with the 'explode' option.

| -| --validate-symlinks |

[Default: false]

If true, the command will validate that symlinks are 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. Bottom-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]

A list of semicolon-separated fields to sort by. The fields must be part of the 'items' AQL domain. For more information read the AQL 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 to Using Placeholders.

| +| | | +|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Command name | rt download | +| Abbreviation | rt dl | +| Command options |

Warning

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 to Build Integration.

| +| --build-number |

[Optional]

Build number. For more details, please refer to Build 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 to Using File Specs.

| +| --spec-vars |

[Optional]

List 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 Artifactory properties specified as "key=value" pairs separated by a semi-colon (for example, "key1=value1;key2=value2;key3=value3"). Only artifacts with all of the specified properties names and values will be downloaded.

| +| --exclude-props |

[Optional]

A list of Artifactory properties specified as "key=value" pairs separated by a semi-colon (for example, "key1=value1;key2=value2;key3=value3"). Only artifacts without all of 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.

If Using Placeholders are 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 --min-split in size). To download each file in a single thread, set to 0.

| +| --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 --split-count segments. Any files smaller than the specified number will be downloaded in a single thread. If set to -1, files are not split.

| +| --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.

| +| --bypass-archive-inspection |

[Default: false]

Set to true to bypass the archive security inspection before it is unarchived. Used with the 'explode' option.

| +| --validate-symlinks |

[Default: false]

If true, the command will validate that symlinks are 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. Bottom-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]

A list of semicolon-separated fields to sort by. The fields must be part of the 'items' AQL domain. For more information read the AQL 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 to Using Placeholders.

| ### Examples #### Example 1 @@ -194,33 +194,33 @@ This command is used to copy files in Artifactory ### Commands Params -| | | -| ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Command name | rt copy | -| Abbreviation | rt cp | -| Command options |

Warning

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.

| +| | | +|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Command name | rt copy | +| Abbreviation | rt cp | +| Command options |

Warning

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 to Using File Specs.

| -| --props |

[Optional]

A list of Artifactory properties specified as "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 Artifactory properties specified as "key=value" pairs separated by a semi-colon (for example, "key1=value1;key2=value2;key3=value3"). Only artifacts without all of 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]

A list of semicolon-separated fields to sort by. The fields must be part of the 'items' AQL domain. For more information read the AQL 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: `[repository name]/[repository path].` You can use wildcards to specify multiple artifacts. | +| --props |

[Optional]

A list of Artifactory properties specified as "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 Artifactory properties specified as "key=value" pairs separated by a semi-colon (for example, "key1=value1;key2=value2;key3=value3"). Only artifacts without all of 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]

A list of semicolon-separated fields to sort by. The fields must be part of the 'items' AQL domain. For more information read the AQL 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: `[repository name]/[repository path].` You can use wildcards to specify multiple artifacts. | | Target path |

Specifies the target path in Artifactory, to which the artifacts should be copied, in the following format: [repository name]/[repository path]

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 to Using Placeholders.

| ### Examples @@ -254,33 +254,33 @@ This command is used to move files in Artifactory ### Commands Params -| | | -| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Command name | rt move | -| Abbreviation | rt mv | -| Command options |

Warning

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.

| +| | | +|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Command name | rt move | +| Abbreviation | rt mv | +| Command options |

Warning

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 to Using File Specs.

| -| --props |

[Optional]

A list of Artifactory properties specified as "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 Artifactory properties specified as "key=value" pairs separated by a semi-colon (for example, "key1=value1;key2=value2;key3=value3"). Only artifacts without all of 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]

A list of semicolon-separated fields to sort by. The fields must be part of the 'items' AQL domain. For more information read the AQL 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: `[repository name]/[repository path].` You can use wildcards to specify multiple artifacts. | +| --props |

[Optional]

A list of Artifactory properties specified as "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 Artifactory properties specified as "key=value" pairs separated by a semi-colon (for example, "key1=value1;key2=value2;key3=value3"). Only artifacts without all of 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]

A list of semicolon-separated fields to sort by. The fields must be part of the 'items' AQL domain. For more information read the AQL 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: `[repository name]/[repository path].` You can use wildcards to specify multiple artifacts. | | Target path |

Specifies the target path in Artifactory, to which the artifacts should be moved, in the following format: [repository name]/[repository path]

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 to Using Placeholders.

| ### Examples @@ -315,12 +315,12 @@ This command is used to delete files in Artifactory ### Commands Params | | | -| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Command name | rt delete | | Abbreviation | rt del | | Command options |

Warning

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 to Using File Specs.

| +| --spec |

[Optional]

Path to a file spec. For more details, please refer to Using File Specs.

| | --props |

[Optional]

A list of Artifactory properties specified as "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 Artifactory properties specified as "key=value" pairs separated by a semi-colon (for example, "key1=value1;key2=value2;key3=value3"). Only artifacts without all of 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.

| @@ -366,7 +366,7 @@ This command is used to search and display files in Artifactory. ### Commands Params | | | -| ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Command name | rt search | | Abbreviation | rt s | | Command options |

Warning

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.

| @@ -427,7 +427,7 @@ This command is used for setting properties on existing files in Artifactory. ### Commands Params | | | -| ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Command name | rt set-props | | Abbreviation | rt sp | | Command options |

Warning

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.

| @@ -479,7 +479,7 @@ This command is used for deleting properties from existing files in Artifactory. ### Commands Params | | | -| ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Command name | rt delete-props | | Abbreviation | rt delp | | Command options |

Warning

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.

| diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/git-lfs.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/git-lfs.md index 5f65a61..a5176d9 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/git-lfs.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/git-lfs.md @@ -6,7 +6,7 @@ This command is used to clean up files from a Git LFS repository. This deletes a ## Commands Params | | | -| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | +|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------| | Command name | rt git-lfs-clean | | Abbreviation | rt glc | | Command options | | diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/managing-configuration-entities.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/managing-configuration-entities.md index eb03c6f..be8c0a6 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/managing-configuration-entities.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/managing-configuration-entities.md @@ -20,7 +20,7 @@ The CSV can include additional columns, with different headers, which will be ig ### Commands Params | | | -| ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | +|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------| | Command-name | rt users-create | | Abbreviation | rt uc | | Command options | | @@ -56,7 +56,7 @@ The CSV can include additional columns, with different headers, which will be ig ### Commands Params | | | -| ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Command-name | rt users-delete | | Abbreviation | rt udel | | Command options | | @@ -89,7 +89,7 @@ This command creates a new users group. ### Commands Params | | | -| ----------------- | ----------------------------------------------------------------------------------- | +|-------------------|-------------------------------------------------------------------------------------| | Command-name | rt group-create | | Abbreviation | rt gc | | Command options | | @@ -112,7 +112,7 @@ This command adds a list fo existing users to a group. ### Commands Params | | | -| ----------------- | ----------------------------------------------------------------------------------- | +|-------------------|-------------------------------------------------------------------------------------| | Command-name | rt group-add-users | | Abbreviation | rt gau | | Command options | | @@ -136,7 +136,7 @@ This command deletes a group. ### Commands Params | | | -| ----------------- | ----------------------------------------------------------------------------------- | +|-------------------|-------------------------------------------------------------------------------------| | Command-name | rt group-delete | | Abbreviation | rt gdel | | Command options | | @@ -165,7 +165,7 @@ When using this command to create the template, you can also provide replaceable #### Commands Params | | | -| ----------------- | ------------------------------------------------------------------------------------------------------------- | +|-------------------|---------------------------------------------------------------------------------------------------------------| | Command-name | rt repo-template | | Abbreviation | rt rpt | | Command options | The command has no options. | @@ -199,7 +199,7 @@ These two commands create a new repository and updates an existing a repository. #### Commands Params | | | -| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Command-name | rt repo-create / rt repo-update | | Abbreviation | rt rc / rt ru | | Command options | | @@ -240,7 +240,7 @@ This command permanently deletes a repository, including all of its content. #### Commands Params | | | -| ----------------- | ---------------------------------------------------------------------------------------------------------- | +|-------------------|------------------------------------------------------------------------------------------------------------| | Command name | rt repo-delete | | Abbreviation | rt rdel | | Command options | | @@ -270,7 +270,7 @@ When using this command to create the template, you can also provide replaceable #### Commands Params | | | -| ----------------- | ------------------------------------------------------------------------------------------------------------- | +|-------------------|---------------------------------------------------------------------------------------------------------------| | Command-name | rt replication-template | | Abbreviation | rt rplt | | Command options | The command has no options. | @@ -303,7 +303,7 @@ This command creates a new replication job for a repository. The command accepts #### Commands Params | | | -| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Command-name | replication-create | | Abbreviation | rt rplc | | Command options | | @@ -336,7 +336,7 @@ This command permanently deletes a replication jobs from a repository. #### Commands Params | | | -| ----------------- | ----------------------------------------------------------------------------------- | +|-------------------|-------------------------------------------------------------------------------------| | Command name | rt replication-delete | | Abbreviation | rt rpldel | | Command options | | @@ -362,7 +362,7 @@ JFrog CLI offers commands creating, updating and deleting permission targets in This command creates a configuration template file, which should be used as an argument for the **jf rt permission-target-create** and **jf rt permission-target-update** commands. | | | -| ----------------- | ------------------------------------------------------------------------------------------------------------- | +|-------------------|---------------------------------------------------------------------------------------------------------------| | Command-name | rt permission-target-template | | Abbreviation | rt ptt | | Command options | The command has no options. | @@ -374,7 +374,7 @@ This command creates a configuration template file, which should be used as an a This command creates a new permission target. The command accepts as an argument a configuration template, which can be created by the **jf rt permission-target-template** command. 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 | | @@ -388,7 +388,7 @@ This command creates a new permission target. The command accepts as an argument This command permanently deletes a permission target. | | | -| ---------------------- | ----------------------------------------------------------------------------------- | +|------------------------|-------------------------------------------------------------------------------------| | Command name | rt permission-target-delete | | Abbreviation | rt ptdel | | Command options | | diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/package-managers-integration.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/package-managers-integration.md index 85f4c9d..5352f64 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/package-managers-integration.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/package-managers-integration.md @@ -6,11 +6,11 @@ JFrog CLI includes integration with Maven, allowing you to resolve dependencies ### Setting maven repositories -Before using the **mvn** command, the project needs to be pre-configured with the Artifactory server and repositories, to be used for building and publishing the project. The **mvn-config** command 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 **.jfrog** directory at the root directory of the project. +Before using the **jf mvn** command, the project needs to be pre-configured with the Artifactory server and repositories, to be used for building and publishing the project. The **jf mvn-config** command 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 **.jfrog** directory at the root directory of the project. | | | -| ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Command-name | mvn-config | | Abbreviation | mvnc | | Command options | | @@ -31,7 +31,7 @@ Before using the **mvn** command, the project needs to be pre-configured with th The **mvn** command triggers the maven client, while resolving dependencies and deploying artifacts from and to Artifactory. -> **Note**: Before running the **mvn** command on a project for the first time, the project should be configured with the **mvn-config** command. +> **Note**: Before running the **mvn** command on a project for the first time, the project should be configured with the **jf mvn-config** command. > **Note**: If the machine running JFrog CLI has no access to the internet, make sure to read the [Downloading the Maven and Gradle Extractor JARs](https://docs.jfrog-applications.jfrog.io/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory#downloading-the-maven-and-gradle-extractor-jars) section. @@ -39,17 +39,17 @@ The **mvn** command triggers the maven client, while resolving dependencies and 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.

| +| | | +|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 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 to Build Integration.

| | --build-number |

[Optional]

Build number. For more details, please refer to Build 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. | +| --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 @@ -73,7 +73,7 @@ JFrog CLI includes integration with Gradle, allowing you to resolve dependencies Before using the **gradle** command, the project needs to be pre-configured with the Artifactory server and repositories, to be used for building and publishing the project. The **gradle-config** command 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\*\*.jfrog\*\* directory at the root directory of the project. | | | -| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +|-------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Command-name | gradle-config | | Abbreviation | gradlec | | Command options | | @@ -94,9 +94,9 @@ Before using the **gradle** command, the project needs to be pre-configured with ### Running gradle -The **gradle** command triggers the gradle client, while resolving dependencies and deploying artifacts from and to Artifactory. +The **jf gradle** command triggers the gradle client, while resolving dependencies and deploying artifacts from and to Artifactory. -> **Note**: Before running the **gradle** command on a project for the first time, the project should be configured with the **gradle-config** command. +> **Note**: Before running the **jf gradle** command on a project for the first time, the project should be configured with the **jf gradle-config** command. > **Note**: If the machine running JFrog CLI has no access to the internet, make sure to read the[Downloading the Maven and Gradle Extractor JARs](https://docs.jfrog-applications.jfrog.io/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory#downloading-the-maven-and-gradle-extractor-jars)section. @@ -104,16 +104,16 @@ The **gradle** command triggers the gradle client, while resolving dependencies 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.

| +| | | +|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 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 to Build Integration.

| | --build-number |

[Optional]

Build number. For more details, please refer to Build Integration.

| -| --project |

[Optional]

JFrog project key.

| -| Command arguments | The command accepts the same arguments and options as the gradle client. | +| --project |

[Optional]

JFrog project key.

| +| Command arguments | The command accepts the same arguments and options as the gradle client. | #### Example @@ -130,7 +130,7 @@ For integrating with Maven and Gradle, JFrog CLI uses the build-info-extractor j 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. 1. Create a remote Maven repository in Artifactory and name it **extractors**. When creating the repository, configure it to proxy [https://releases.jfrog.io/artifactory/oss-release-local](https://releases.jfrog.io/artifactory/oss-release-local) -2. Make sure that this Artifactory server is known to JFrog CLI, using the [jfrog c show](https://docs.jfrog-applications.jfrog.io/jfrog-applications/jfrog-cli/configurations/jfrog-platform-configuration#showing-the-configured-servers) command. If not, configure it using the [jfrog c add](https://jfrog.com/help/r/jfrog-cli/Adding-and-Editing-Configured-Servers) command. +2. Make sure that this Artifactory server is known to JFrog CLI, using the [jf c show](https://docs.jfrog-applications.jfrog.io/jfrog-applications/jfrog-cli/configurations/jfrog-platform-configuration#showing-the-configured-servers) command. If not, configure it using the [jf c add](https://jfrog.com/help/r/jfrog-cli/Adding-and-Editing-Configured-Servers) command. 3. Set the **JFROG\_CLI\_EXTRACTORS\_REMOTE** environment variable with the server ID of the Artifactory server you configured, followed by a slash, and then the name of the repository you created. For example _**my-rt-server/extractors**_ ## Running Builds with MSBuild @@ -166,61 +166,61 @@ Check out our [docker project examples on GitHub](https://github.com/jfrog/proje ### Pulling Docker Images Using the Docker Client -Running **docker-pull** command 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 the [build-publish](https://docs.jfrog-applications.jfrog.io/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory#publishing-build-info) command. +Running **jf docker pull** command 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 the [build-publish](https://docs.jfrog-applications.jfrog.io/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory#publishing-build-info) command. #### Commands Params 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.

| +| | | +|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 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 to Build Integration.

| | --build-number |

[Optional]

Build number. For more details, please refer to Build 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/ | +| --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/ | #### Example -The subsequent command utilizes the docker client to pull the 'my-docker-registry.io/my-docker-image:latest' image from Artifactory. This operation logs the image layers as dependencies of the local build-info identified by the build name 'my-build-name' and build number '7'. This local build-info can subsequently be released to Artifactory using the command 'jf rt bp my-build-name 7'." +The subsequent command utilizes the docker client to pull the 'my-docker-registry.io/my-docker-image:latest' image from Artifactory. This operation logs the image layers as dependencies of the local build-info identified by the build name 'my-build-name' and build number '7'. This local build-info can subsequently be released to Artifactory using the command 'jf rt bp my-build-name 7'. ``` 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 the **docker-pull** command to Artifactory using the [build-publish](https://docs.jfrog-applications.jfrog.io/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory#publishing-build-info) command. +You can then publish the build-info collected by the **jf docker pull** command to Artifactory using the [build-publish](https://docs.jfrog-applications.jfrog.io/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory#publishing-build-info) command. ### Pushing Docker Images Using the Docker Client -After building your image using the docker client, the **docker-push** command 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 the **build-publish** command. +After building your image using the docker client, the **jf docker push** command 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 the **jf rt build-publish** command. #### Commands Params 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.

| +| | | +|--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 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 to Build Integration.

| | --build-number |

[Optional]

Build number. For more details, please refer to Build 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/ | +| --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/ | #### Example -The subsequent command utilizes the docker client to push the 'my-docker-registry.io/my-docker-image:latest' image to Artifactory. This operation logs the image layers as artifacts of the local build-info identified by the build name 'my-build-name' and build number '7'. This local build-info can subsequently be released to Artifactory using the command 'jf rt bp my-build-name 7'." +The subsequent command utilizes the docker client to push the 'my-docker-registry.io/my-docker-image:latest' image to Artifactory. This operation logs the image layers as artifacts of the local build-info identified by the build name 'my-build-name' and build number '7'. This local build-info can subsequently be released to Artifactory using the command 'jf rt bp my-build-name 7'. ``` jf docker push my-docker-registry.io/my-docker-image:latest --build-name=my-build-name --build-number=7 @@ -230,30 +230,30 @@ You can then publish the build-info collected by the **docker-push** command to ### Pulling Docker Images Using Podman -[Podman](https://podman.io/) is a daemonless container engine for developing, managing, and running OCI Containers. Running the **podman-pull** command 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 the [build-publish](https://docs.jfrog-applications.jfrog.io/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory#publishing-build-info) command. +[Podman](https://podman.io/) is a daemon-less container engine for developing, managing, and running OCI Containers. Running the **podman-pull** command 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 the [build-publish](https://docs.jfrog-applications.jfrog.io/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory#publishing-build-info) command. #### Commands Params 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.

| +| | | +|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 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 to Build Integration.

| | --build-number |

[Optional]

Build number. For more details, please refer to Build 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. | +| --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. | #### Example -In this example, podman is employed to pull the local image 'my-docker-registry.io/my-docker-image:latest' from the docker-local Artifactory repository. During this process, it registers the image layers as depedencies within a build-info identified by the build name 'my-build-name' and build number '7'. This build-info is initially established locally and must be subsequently published to Artifactory using the command 'jf rt build-publish my-build-name 7'. +In this example, podman is employed to pull the local image 'my-docker-registry.io/my-docker-image:latest' from the docker-local Artifactory repository. During this process, it registers the image layers as dependencies within a build-info identified by the build name 'my-build-name' and build number '7'. This build-info is initially established locally and must be subsequently published to Artifactory using the command 'jf rt build-publish my-build-name 7'. ``` jf rt podman-pull my-docker-registry.io/my-docker-image:latest docker-local --build-name my-build-name --build-number 7 @@ -269,22 +269,22 @@ You can then publish the build-info collected by the **podman-pull** command to 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.

| +| | | +|--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 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 to Build Integration.

| | --build-number |

[Optional]

Build number. For more details, please refer to Build 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. | +| --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. | #### Example @@ -318,14 +318,14 @@ The **build-docker-create** command allows adding a docker image, which is alrea #### Commands Params | | | -| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | 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 to Build Integration.

| -| --build-number |

[Optional]

Build number. For more details, please refer to Build Integration.

| +| --build-name |

[Optional]

Build name. For more details, please refer to Build Integration.

| +| --build-number |

[Optional]

Build number. For more details, please refer to Build 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.

| @@ -355,7 +355,7 @@ Promotion is the action of moving or copying a group of artifacts from one repos The following table lists the command arguments and flags: | | | -| --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | +|-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------| | Command-name | rt docker-promote | | Abbreviation | rt dpr | | Command options | | @@ -394,41 +394,41 @@ Artifactory version 5.5.2 and above. ### Setting npm repositories -Before using the **npm-install**, **npm-ci** and **npm-publish** commands, the project needs to be pre-configured with the Artifactory server and repositories, to be used for building and publishing the project. The **npm-config** command 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 **.jfrog** directory at the root directory of the project. +Before using the **jf npm install**, **jf npm ci** and **jf npm publish** commands, the project needs to be pre-configured with the Artifactory server and repositories, to be used for building and publishing the project. The **jf npm-config** command 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 **.jfrog** directory 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.

| +| --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.

| | Command arguments | The command accepts no arguments | ### Installing Npm Packages -The **npm-install** and **npm-ci** commands execute npm's **install** and **ci** commands respectively, to fetches the npm dependencies from the npm repositories. +The **jf npm install** and **jf npm ci** commands execute npm's **install** and **ci** commands respectively, to fetches the npm dependencies from the npm repositories. -Before running the **npm-install** or **npm-ci** command on a project for the first time, the project should be configured using the **npm-config** command. +Before running the **jf npm install** or **jf npm ci** command on a project for the first time, the project should be configured using the **jf npm-config** command. #### Commands Params The following table lists the command arguments and flags: -| | | -| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Command-name | npm | -| Abbreviation | | -| Command options | | +| | | +|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Command-name | npm | +| Abbreviation | | +| Command options | | | --build-name |

[Optional]

Build name. For more details, please refer to Build Integration.

| | --build-number |

[Optional]

Build number. For more details, please refer to Build 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. | +| --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 @@ -459,7 +459,7 @@ jf npm ci The **npm-publish** command 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 the **npm-config** command. This configuration includes the Artifactory server and repository to which the package should deploy. +Before running the **npm-publish** command on a project for the first time, the project should be configured using the **jf npm-config** command. This configuration includes the Artifactory server and repository to which the package should deploy. > **Warning**: If your npm package includes the prepublish or postpublish scripts, please refer to the guidelines above. @@ -467,19 +467,19 @@ Before running the **npm-publish** command on a project for the first time, the 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 to Build Integration.

| -| --build-number |

[Optional]

Build number. For more details, please refer to Build 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 the **npm pack** command expects. | +| | | +|--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Command-name | npm publish | +| Abbreviation | | +| Command options | | +| --build-name |

[Optional]

Build name. For more details, please refer to Build Integration.

| +| --build-number |

[Optional]

Build number. For more details, please refer to Build 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 the **npm pack** command expects. | #### Example @@ -500,7 +500,7 @@ Yarn version 2.4.0 and above is supported. Before using the **jf yarn** command, the project needs to be pre-configured with the Artifactory server and repositories, to be used for building the project. The **yarn-config** command 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 **.jfrog** directory at the root directory of the project. | | | -| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Command-name | yarn-config | | Abbreviation | yarnc | | Command options | | @@ -513,22 +513,22 @@ Before using the **jf yarn** command, the project needs to be pre-configured wit The **jf yarn** command executes the yarn client, to fetch the npm dependencies from the npm repositories. -> **Note**: Before running the command on a project for the first time, the project should be configured using the **yarn-config** command. +> **Note**: Before running the command on a project for the first time, the project should be configured using the **jf yarn-config** command. #### Commands Params The following table lists the command arguments and flags: -| | | -| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Command-name | yarn | -| Command options | | +| | | +|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Command-name | yarn | +| Command options | | | --build-name |

[Optional]

Build name. For more details, please refer to Build Integration.

| | --build-number |

[Optional]

Build number. For more details, please refer to Build 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. | +| --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 @@ -541,7 +541,7 @@ 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 by \*\*yarn-config command. +The following example installs the dependencies. The dependencies are resolved from the Artifactory server and repository configured by **jf yarn-config** command. ``` jf yarn install @@ -572,12 +572,12 @@ Before you can use JFrog CLI to build your Go projects with Artifactory, you fir Here's how you set the repositories. 1. 'cd' into to the root of the Go project. -2. Run the **jf rt go-config** command. +2. Run the **jf go-config** command. #### Commands Params | | | -| ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Command-name | go-config | | Abbreviation | | | Command options | | @@ -608,24 +608,24 @@ jf go-config --global The **go** command triggers the go client. -> **Note**: Before running the **go** command on a project for the first time, the project should be configured using the **go-config** command. +> **Note**: Before running the **go** command on a project for the first time, the project should be configured using the **jf go-config** command. #### Commands Params The following table lists the command arguments and flags: -| | | -| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Command-name | go | -| Abbreviation | go | -| Command options | | +| | | +|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Command-name | go | +| Abbreviation | go | +| Command options | | | --build-name |

[Optional]

Build name. For more details, please refer to Build Integration.

| | --build-number |

[Optional]

Build number. For more details, please refer to Build 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. | +| --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 @@ -635,7 +635,7 @@ The following example runs Go build command. The dependencies resolved from Arti > **Note**: Before using this example, please make sure to set repositories for the Go project using the go-config command. ``` -jf rt go build +jf go build ``` ##### Example 2 @@ -650,31 +650,31 @@ jf rt go build --build-name=my-build --build-number=1 ### Publishing Go Packages to Artifactory -The **go-publish** command packs and deploys the Go package to the designated Go repository in Artifactory. +The **jf go-publish** command packs and deploys the Go package to the designated Go repository in Artifactory. -> **Note**: Before running the **go-publish** command on a project for the first time, the project should be configured using the **go-config** command. +> **Note**: Before running the **jf go-publish** command on a project for the first time, the project should be configured using the **jf go-config** command. #### Commands Params The following table lists the command arguments and flags: -| | | -| ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Command-name | go-publish | -| Abbreviation | gp | -| Command options | | +| | | +|--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Command-name | go-publish | +| Abbreviation | gp | +| Command options | | | --build-name |

[Optional]

Build name. For more details, please refer to Build Integration.

| | --build-number |

[Optional]

Build number. For more details, please refer to Build 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 | +| --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 the **go-config** command. +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 the **jf go-config** command. ``` jf gp v1.2.3 @@ -682,7 +682,7 @@ jf gp v1.2.3 ##### Example 2 -To pack and publish the Go package and also record the build-info as part of build **my-build-name/1** , run the following command. The build-info can later be published to Artifactory using the [build-publish](https://docs.jfrog-applications.jfrog.io/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory#publishing-build-info) command. Before running this command on a project for the first time, the project should be configured using the **go-config** command. +To pack and publish the Go package and also record the build-info as part of build **my-build-name/1** , run the following command. The build-info can later be published to Artifactory using the [build-publish](https://docs.jfrog-applications.jfrog.io/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory#publishing-build-info) command. Before running this command on a project for the first time, the project should be configured using the **jf go-config** command. ``` jf gp v1.2.3 --build-name my-build-name --build-number 1 @@ -710,7 +710,7 @@ Here's how you set the repositories. #### Commands Params | | | -| ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Command-name | pip-config / pipenv-config / poetry-config | | Abbreviation | pipc / pipec / poc | | Command options | | @@ -769,9 +769,9 @@ jf pipec --global ### Installing Python packages -The **pip install**, **pipenv install** and **poetry install** commands use the **pip**, **pipenv** and **poetry** clients respectively, to install the project dependencies from Artifactory. The **pip install** and **pipenv install** commands can also record these packages as build dependencies as part of the build-info published to Artifactory. +The **jf pip install**, **jf pipenv install** and **jf poetry install** commands use the **pip**, **pipenv** and **poetry** clients respectively, to install the project dependencies from Artifactory. The **jf pip install** and **jf pipenv install** commands can also record these packages as build dependencies as part of the build-info published to Artifactory. -> **Note**: Before running the **pip install**, **pipenv install** and **poetry install** commands on a project for the first time, the project should be configured using the **pip-config** ,**pipenv-config** or **poetry-config** commands respectively. +> **Note**: Before running the **pip install**, **pipenv install** and **poetry install** commands on a project for the first time, the project should be configured using the **jf pip-config** ,**jf pipenv-config** or **jf poetry-config** commands respectively. **Recording all dependencies** - currently available for pip and pipenv. @@ -840,7 +840,7 @@ Before using the nuget or dotnet commands, the **nuget-config** or **dotnet-conf The following table lists the commands' options: | | | -| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Command-name | nuget-config / dotnet-config | | Abbreviation | nugetc / dotnetc | | Command options | | @@ -862,16 +862,16 @@ The **nuget** command runs the **NuGet client** and the **dotnet** command runs The following table lists the commands arguments and options: -| | | -| ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Command-name | nuget / dotnet | -| Abbreviation | | -| Command options | | +| | | +|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Command-name | nuget / dotnet | +| Abbreviation | | +| Command options | | | --build-name |

[Optional]

Build name. For more details, please refer to Build Integration.

| | --build-number |

[Optional]

Build number. For more details, please refer to Build 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. | +| --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 @@ -921,7 +921,7 @@ The **jf terraform-config** command will store the repository name inside the ** The following table lists the command options: | | | -| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +|--------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Command-name | terraform-config | | Abbreviation | tfc | | Command options | | @@ -955,19 +955,19 @@ The **terraform publish** command creates a terraform package for the module in 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 patterns wildcards. 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 to Build Integration.

| -| --build-number |

[Optional]

Build number. For more details, please refer to Build Integration.

| -| --project | | -| Command argument | The command accepts no arguments | +| | | +|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 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 patterns wildcards. 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 to Build Integration.

| +| --build-number |

[Optional]

Build number. For more details, please refer to Build Integration.

| +| --project | | +| Command argument | The command accepts no arguments | #### Examples ##### Example 1 diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/verifying-artifactory-accessibility.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/verifying-artifactory-accessibility.md index e80c3b1..703ee7c 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/verifying-artifactory-accessibility.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/verifying-artifactory-accessibility.md @@ -5,7 +5,7 @@ This command can be used to verify that Artifactory is accessible by sending an ## Commands Params | | | -| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | +|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------| | Command name | rt ping | | Abbreviation | rt p | | | | diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-cloud-transfer.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-cloud-transfer.md index d2427bd..b27ba20 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-cloud-transfer.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-cloud-transfer.md @@ -45,7 +45,7 @@ The following limitations need to be kept in mind before you start the migration 5. Artifacts in remote repositories caches are not transferred. 6. Federated repositories are transferred without their federation members. After the transfer, you'll need to reconfigure the federation as described in the Federated Repositories documentation. Federated Repositories 7. Docker repositories with names that include dots or underscores aren't allowed in JFrog Cloud. -8. Artifact properties with a value longer than 2.4K characters are not supported in JFrog Cloud. Such properties are generally seen in Conan artifacts. The artifacts will transferred without the properties in this case. A report with these artifacts will become available to you at the end of the transfer. +8. Artifact properties with a value longer than 2.4K characters are not supported in JFrog Cloud. Such properties are generally seen in Conan artifacts. The artifacts will be transferred without the properties in this case. A report with these artifacts will become available to you at the end of the transfer. 9. The files transfer process allows transferring files that were created or modified on the source instance after the process started. However, files that were deleted on the source instance after the process started, are not deleted on the target instance by the process. 10. The files transfer process allows transferring files that were created or modified on the source instance after the process started. The custom properties of those files are also updated on the target instance. However, if only the custom properties of those files were modified on the source, but not the files' content, the properties are not modified on the target instance by the process. @@ -86,7 +86,7 @@ Follow the below steps to enable the configuration transfer. 4. If you have an Enterprise+ subscription with more than one Artifactory instance, select the target instance from the drop-down menu. 5. Toggle **Enable Configuration Transfer** to enable the transfer. The process may take a few minutes to complete. \ ![](../.gitbook/assets/transfer-2.png) -6. The configuration transfer is now enabled and you can continue with the transfer process. +6. The configuration transfer is now enabled, and you can continue with the transfer process. #### Step 2: Set up the source instance for pushing files to the target instance @@ -173,7 +173,7 @@ This command might take up to two minutes to run. *** -6. View the command output in the terminal to verify that there are no errors. The command output is divided in to the following four phases: +6. View the command output in the terminal to verify that there are no errors. The command output is divided into the following four phases: ``` ========== Phase 1/4 - Preparations ========== diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-curation.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-curation.md index 19aa062..f0e64b3 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-curation.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-curation.md @@ -36,7 +36,7 @@ Before running the command, do the following: #### Commands Params | | | -| ------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------------| | **Command name** | curation-audit | | **Abbreviation** | ca | | **Command options** | | diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-distribution.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-distribution.md index d822e82..6c94740 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-distribution.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-distribution.md @@ -35,12 +35,12 @@ This commands creates and updates an unsigned Release Bundle on JFrog Distributi #### Commands Params | | | -|------------------------| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Command-name | release-bundle-create / release-bundle-update | | Abbreviation | rbc / rbu | | Command options | | | --server-id |

[Optional]

Artifactory server ID configured using the config command.

| -| --spec |

[Optional]

Path to a file spec. For more details, please refer to Using File Specs.

| +| --spec |

[Optional]

Path to a file spec. For more details, please refer to Using File Specs.

| | --spec-vars |

[Optional]

List 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}.

| | --target-props |

[Optional]

The list of properties, in the form of key1=value1;key2=value2,..., to be added to the artifacts after distribution of the release bundle.

| | --target |

[Optional]

The target path for distributed artifacts on the edge node. If not specified, the artifacts will have the same path and name on the edge node, as on the source Artifactory server. For flexibility in specifying the distribution path, you can include placeholders in the form of {1}, {2} which are replaced by corresponding tokens in the pattern path that are enclosed in parenthesis.

| @@ -181,7 +181,7 @@ This command GPG signs an existing Release Bundle on JFrog Distribution. #### Commands Params | | | -| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | +|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------| | Command-name | release-bundle-sign | | Abbreviation | rbs | | Command options | | @@ -217,7 +217,7 @@ This command distributes a release bundle to the Edge Nodes. #### Commands Params | | | -| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Command-name | release-bundle-distribute | | Abbreviation | rbd | | Command options | | @@ -259,7 +259,7 @@ This command deletes a Release Bundle from the Edge Nodes and optionally from Di #### Commands Params | | | -| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | +|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Command-name | release-bundle-delete | | Abbreviation | rbdel | | Command options | | diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-pipelines.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-pipelines.md index 11fc6a7..69f3833 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-pipelines.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-pipelines.md @@ -15,7 +15,7 @@ $ jf pl command-name arguments command-options Where: | | | -| --------------- | ----------------------------------------------------------------------------------------------- | +|-----------------|-------------------------------------------------------------------------------------------------| | command-name | The command to execute. Note that you can use either the full command name or its abbreviation. | | command-options | A set of options corresponding to the command | | arguments | A set of arguments corresponding to the command | @@ -31,7 +31,7 @@ The following sections describe the commands available in the JFrog CLI for use ##### Commands Params | | | -| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | +|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------| | Command name | pl version | | Abbreviation | v | | Command arguments | The command accepts no arguments. | @@ -52,7 +52,7 @@ Get the status of the run for the specified pipeline ##### Commands Params | | | -| ----------------- | ------------------------------------------------------------------------------------------------------------------------------ | +|-------------------|--------------------------------------------------------------------------------------------------------------------------------| | Command name | pl status | | Abbreviation | s | | Command arguments | The command accepts no arguments. | @@ -86,7 +86,7 @@ Trigger a pipeline run. ##### Commands Params | | | -| ----------------- | ------------------------------------------------------------------------------------------------------------------------ | +|-------------------|--------------------------------------------------------------------------------------------------------------------------| | Command name | pl trigger | | Abbreviation | t | | Command options | | @@ -117,7 +117,7 @@ jf pl trigger myPipeline main/jobs --server-id repo21 ##### Commands Params | | | -| --------------- | ----------------------------------------------------------------------------------------- | +|-----------------|-------------------------------------------------------------------------------------------| | Command name | pl sync | | Abbreviation | sy | | Command options | | @@ -137,7 +137,7 @@ jf pl sync --repository jfrog/artifactory --branch main/jobs --server-id repo21 ##### Commands Params | | | -| ----------------- | ---------------------------------------------------------------- | +|-------------------|------------------------------------------------------------------| | Command name | pl sync-status | | Abbreviation | ss | | Command options | | diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-security/README.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-security/README.md index a7b61cd..210fd4e 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-security/README.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-security/README.md @@ -15,7 +15,7 @@ To authenticate yourself using your Xray login credentials, either configure you To authenticate yourself using an Xray Access Token, either configure your Access Token once using the \_jf c add\_command or provide the following option to each command. | | | -| -------------- | ------------------------------------------------------- | +|----------------|---------------------------------------------------------| | Command option | Description | | --url | JFrog Xray API endpoint URL. It usually ends with /xray | | --access-token | JFrog access token | diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-published-builds.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-published-builds.md index b705d75..2633df2 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-published-builds.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-published-builds.md @@ -7,7 +7,7 @@ JFrog CLI is integrated with JFrog Xray and JFrog Artifactory, allowing you to h ### Commands Params | | | -| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Command name | build-scan | | Abbreviation | bs | | Command options | | diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-your-binaries.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-your-binaries.md index bfb4e5f..a54b1c1 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-your-binaries.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-your-binaries.md @@ -20,7 +20,7 @@ This _**jf scan**_ command scans files on the local file system with Xray. #### Commands Params | | | -| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **Command name** | scan | | **Abbreviation** | s | | **Command options** | | @@ -100,7 +100,7 @@ This j\_**f docker scan**\_ command scans docker containers located on the local #### Commands Params | | | -| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **Command name** | docker scan | | **Abbreviation** | | | **Command options** | | diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-your-source-code.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-your-source-code.md index 11bc456..806590a 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-your-source-code.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-your-source-code.md @@ -36,7 +36,7 @@ This command also supports the following Advanced Scans with the **Advanced Secu #### Commands Params | | | -| --------------------- |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +|-----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **Command name** | audit | | **Abbreviation** | aud | | **Command options** | | @@ -59,7 +59,7 @@ This command also supports the following Advanced Scans with the **Advanced Secu | --gradle |

[Default: false]

Set to true to request audit for a Gradle project.

| | --mvn |

[Default: false]

Set to true to request audit for a Maven project.

| | --npm |

[Default: false]

Set to true to request audit for a npm project.

| -| --pnpm |

[Default: false]

Set to true to request audit for a pnpm project.

| +| --pnpm |

[Default: false]

Set to true to request audit for a pnpm project.

| | --nuget |

[Default: false]

Set to true to request audit for a .Net project.

| | --pip |

[Default: false]

Set to true to request audit for a Pip project.

| | --pipenv |

[Default: false]

Set to true to request audit for a Pipenv project.

| @@ -131,7 +131,7 @@ Execute a cUrl command, using the configured Xray details. The command expects t #### Commands Params | | | -| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Command name | xr curl | | Abbreviation | xr cl | | Command options | | diff --git a/jfrog-applications/jfrog-cli/cli-plugins/README.md b/jfrog-applications/jfrog-cli/cli-plugins/README.md index f7f85b5..13d6bb9 100644 --- a/jfrog-applications/jfrog-cli/cli-plugins/README.md +++ b/jfrog-applications/jfrog-cli/cli-plugins/README.md @@ -22,7 +22,7 @@ To create your own private plugins registry, follow these steps. * On your Artifactory server, create a local generic repository named _jfrog-cli-plugins_. * Make sure your Artifactory server is included in JFrog CLI's configuration, by running the _jf c show_ command. -* If needed, configure your Artifactory instance using the _jfrog c add_ command. +* If needed, configure your Artifactory instance using the _jf c add_ command. * Set the ID of the configured server as the value of the JFROG_CLI_PLUGINS_SERVER environment variable. * If you wish the name of the plugins repository to be different from jfrog-cli-plugins, set this name as the value of the JFROG_CLI_PLUGINS_REPO environment variable. diff --git a/jfrog-applications/jfrog-cli/cli-plugins/developer-guide.md b/jfrog-applications/jfrog-cli/cli-plugins/developer-guide.md index 0e1e8d0..cf0cb80 100644 --- a/jfrog-applications/jfrog-cli/cli-plugins/developer-guide.md +++ b/jfrog-applications/jfrog-cli/cli-plugins/developer-guide.md @@ -94,7 +94,7 @@ the following guidelines before publishing it. * **Create a Readme.** Make sure that your plugin code includes a README.md file and place it in the root of the repository. The README needs to be structured according to the [jfrog-cli-plugin-template]((https://github.com/jfrog/jfrog-cli-plugin-template.git)) README. It needs to include - all the information and relevant details for the relevant plugin users.. + all the information and relevant details for the relevant plugin users. * **Consider create a tag for your plugin sources.** Although this is not mandatory, we recommend creating a tag for your GitHub repository before publishing the plugin. You can then provide this tag to the Registry when publishing the plugin, to make sure the correct code is built. From 2e20483343e1a8c3008a5281d45c1c689ebeb995 Mon Sep 17 00:00:00 2001 From: Michael Sverdlov Date: Sun, 14 Apr 2024 18:12:23 +0300 Subject: [PATCH 2/9] fix docs --- .../package-managers-integration.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/package-managers-integration.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/package-managers-integration.md index 37431a4..8ad38c0 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/package-managers-integration.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/package-managers-integration.md @@ -429,9 +429,9 @@ The following table lists the command arguments and flags: | --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. | -| --project |

[Optional]

JFrog project key.

| -| --module |

[Optional]

Optional module name for the build-info.

| -| Command arguments | The command accepts the same arguments and options as the npm client. | +| --project |

[Optional]

JFrog project key.

| +| --module |

[Optional]

Optional module name for the build-info.

| +| Command arguments | The command accepts the same arguments and options as the npm client. | #### Examples ##### Example 1 From 510284ab3c05b0759eea6593658f712394723da2 Mon Sep 17 00:00:00 2001 From: Michael Sverdlov Date: Sun, 14 Apr 2024 19:39:48 +0300 Subject: [PATCH 3/9] fix docs --- .../build-integration.md | 154 ++--- .../curl-integration.md | 2 +- .../environment-variables.md | 12 +- .../generic-files.md | 485 ++++++++------- .../managing-configuration-entities.md | 182 +++--- .../package-managers-integration.md | 570 +++++++++--------- .../release-lifecycle-management.md | 76 +-- .../verifying-artifactory-accessibility.md | 20 +- .../jfrog-cli/cli-for-jfrog-curation.md | 16 +- .../jfrog-cli/cli-for-jfrog-distribution.md | 148 ++--- .../jfrog-cli/cli-for-jfrog-pipelines.md | 76 +-- .../download-updates-for-xrays-database.md | 2 +- .../scan-published-builds.md | 12 +- .../scan-your-binaries.md | 26 +- .../scan-your-source-code.md | 50 +- .../jfrog-platform-configuration.md | 4 +- 16 files changed, 939 insertions(+), 896 deletions(-) diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/build-integration.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/build-integration.md index 259cc07..3bcf1cb 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/build-integration.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/build-integration.md @@ -42,15 +42,15 @@ Environment variables are collected using the `build-collect-env` (`bce`) comman 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. | +| | | +|-------------------|-----------------------------------------| +| 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. | #### Examples ##### Example 1 @@ -77,18 +77,18 @@ The `build-add-git` (bag) command collects the Git revision and URL from the loc 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 the 'jf config' command. This is the server to which the build-info will be later published, using the jf rt build-publish command. This option, if provided, overrides the serverID value in this command's yaml configuration. If both values are not provided, the default server, configured by the 'jf config' command, is used.

| -| --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. | +| | | +|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 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 the 'jf config' command. This is the server to which the build-info will be later published, using the jf rt build-publish command. This option, if provided, overrides the serverID value in this command's yaml configuration. If both values are not provided, the default server, configured by the 'jf config' command, is used.

| +| --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. | #### Configuration file properties @@ -142,15 +142,15 @@ By default, the command collects the files from the local file system. If you'd |-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Command name | rt build-add-dependencies | | Abbreviation | rt bad | -| Command options |

Warning

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]

List 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.

| -| --module |

[Optional]

Optional module name in the build-info for adding the dependency.

| +| 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 |

[Optional]
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]
List 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 |

[Optional]
Set to true to only get a summery of the dependencies that will be added to the build info.

| +| --module |

[Optional]
Optional module name in the build-info for adding the dependency.

| | --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 three arguments. | | Build name | The build name to add the dependencies to | @@ -193,21 +193,21 @@ jf rt bp my-build-name 18 ### Commands Params -| | | -|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| 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: *]

List 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*]

List 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. | +| | | +|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 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: *]
List 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*]
List of case insensitive patterns in the form of "value1;value2;..." environment variables match those patterns will be excluded.

| +| --dry-run |

[Optional]
Set to true to disable communication with Artifactory.

| +| --insecure-tls |

[Optional]
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 @@ -298,25 +298,25 @@ This command is used to [promote build](https://jfrog.com/knowledge-base/how-doe ### Commands Params -| | | -|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------| -| 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]

List 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. | +| | | +|------------------------|------------------------------------------------------------------------------------------------------------------------------------------| +| 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 |

[Optional]
If set to true, the build dependencies are also promoted.

| +| --copy |

[Optional]
If set true, the build artifacts and dependencies are copied to the target repository, otherwise they are moved.

| +| --props |

[Optional]
List of properties in the form of "key1=value1;key2=value2,...". to attach to the build artifacts.

| +| --dry-run |

[Optional]
If true, promotion is only simulated. The build is not promoted.

| +| --insecure-tls |

[Optional]
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 @@ -360,19 +360,19 @@ This command is used to discard builds previously published to Artifactory using The following table lists the command arguments and flags: -| | | -|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------| -| Command name | rt build-discard | -| Abbreviation | rt bdi | -| Command options | | -| --server-id |

[Optional]

Server 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]

List 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. | +| | | +|--------------------|------------------------------------------------------------------------------------------------------------------------------------------| +| Command name | rt build-discard | +| Abbreviation | rt bdi | +| Command options | | +| --server-id |

[Optional]
Server 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]
List of build numbers in the form of "value1,value2,...", that should not be removed from Artifactory.

| +| --delete-artifacts |

[Optional]
If set to true, automatically removes build artifacts stored in Artifactory.

| +| --async |

[Optional]
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. | ### Examples #### Example 1 diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/curl-integration.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/curl-integration.md index 352f122..ef9c4d8 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/curl-integration.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/curl-integration.md @@ -12,7 +12,7 @@ Execute a cUrl command, using the configured Artifactory details. The command ex | Command name | rt curl | | | Abbreviation | rt cl | | | Command options | | | -| --server-id |

[Optional]

Server ID configured using the jf c add command. If not specified, the default configured server is used.

| | +| --server-id |

[Optional]
Server ID configured using the jf c add command. 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:

1. The full Artifactory URL should not be passed. Instead, the REST endpoint URI should be sent.
2. The login credentials should not be passed. Instead, the --server-id should be used.

| | diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/environment-variables.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/environment-variables.md index 425bd93..661458d 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/environment-variables.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/environment-variables.md @@ -6,18 +6,18 @@ Some of the Artifactory commands make use of the following environment variable: | | | |----------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **Variable Name** | **Description** | -| **JFROG\_CLI\_MIN\_CHECKSUM\_DEPLOY\_SIZE\_KB** |

[Default: 10]

Minimum file size in KB for which JFrog CLI performs checksum deploy optimization.

| +| **JFROG\_CLI\_MIN\_CHECKSUM\_DEPLOY\_SIZE\_KB** |

[Default: 10]
Minimum file size in KB for which JFrog CLI performs checksum deploy optimization.

| | **JFROG\_CLI\_RELEASES\_REPO** |

Configured Artifactory repository name to download the jar needed by the mvn/gradle command.
This environment variable's value format should be <server ID configured by the 'jf c add' command>/<repo name>.
The repository should proxy https://releases.jfrog.io.
This environment variable is used by the 'jf mvn' and 'jf gradle' commands, and also by the 'jf audit' command, when used for maven or gradle projects.

| -| **JFROG\_CLI\_DEPENDENCIES\_DIR** |

[Default: $JFROG_CLI_HOME_DIR/dependencies]

Defines the directory to which JFrog CLI's internal dependencies are downloaded.

| -| **JFROG\_CLI\_REPORT\_USAGE** |

[Default: true]

Set to false to block JFrog CLI from sending usage statistics to Artifactory.

| +| **JFROG\_CLI\_DEPENDENCIES\_DIR** |

[Default: $JFROG_CLI_HOME_DIR/dependencies]
Defines the directory to which JFrog CLI's internal dependencies are downloaded.

| +| **JFROG\_CLI\_REPORT\_USAGE** |

[Default: true]
Set to false to block JFrog CLI from sending usage statistics to Artifactory.

| | **JFROG\_CLI\_SERVER\_ID** | Server ID configured using the config command, unless sent as a command argument or option. | | **JFROG\_CLI\_BUILD\_NAME** | Build name to be used by commands which expect a build name, unless sent as a command argument or option. | | **JFROG\_CLI\_BUILD\_NUMBER** | Build number to be used by commands which expect a build number, unless sent as a command argument or option. | | **JFROG\_CLI\_BUILD\_PROJECT** | JFrog project key to be used by commands that expect build name and build number. Determines the project of the published build. | | **JFROG\_CLI\_BUILD\_URL** | Sets the CI server build URL in the build-info. The "jf rt build-publish" command uses the value of this environment variable unless the --build-url command option is sent. | -| **JFROG\_CLI\_ENV\_EXCLUDE** |

[Default: *password*;*secret*;*key*;*token*]

List of case insensitive patterns in the form of "value1;value2;...". Environment variables match those patterns will be excluded. This environment variable is used by the "jf rt build-publish" command, in case the --env-exclude command option is not sent.

| -| **JFROG\_CLI\_TRANSITIVE\_DOWNLOAD\_EXPERIMENTAL** |

[Default: false]

Used by the "jf rt download" command. Set to true to download artifacts also from remote repositories. This feature is experimental and available on Artifactory version 7.17.0 or higher.

| -| **JFROG\_CLI\_UPLOAD\_EMPTY\_ARCHIVE** |

[Default: false]

Used by the "jf rt upload" command. Set to true if you'd like to upload an empty archive when '--archive' is set but all files were excluded by exclusions pattern.

| +| **JFROG\_CLI\_ENV\_EXCLUDE** |

[Default: *password*;*secret*;*key*;*token*]
List of case insensitive patterns in the form of "value1;value2;...". Environment variables match those patterns will be excluded. This environment variable is used by the "jf rt build-publish" command, in case the --env-exclude command option is not sent.

| +| **JFROG\_CLI\_TRANSITIVE\_DOWNLOAD\_EXPERIMENTAL** |

[Optional]
Used by the "jf rt download" command. Set to true to download artifacts also from remote repositories. This feature is experimental and available on Artifactory version 7.17.0 or higher.

| +| **JFROG\_CLI\_UPLOAD\_EMPTY\_ARCHIVE** |

[Optional]
Used by the "jf rt upload" command. Set to true if you'd like to upload an empty archive when '--archive' is set but all files were excluded by exclusions pattern.

| *** diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/generic-files.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/generic-files.md index fa355e1..2281bbb 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/generic-files.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/generic-files.md @@ -4,45 +4,50 @@ This command is used to upload files to Artifactory. +### Usage + +```jf rt u [command options] ``` +```jf rt u --spec= [command options]``` + ### Commands Params | | | |--------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Command name | rt upload | | Abbreviation | rt u | -| Command options |

Warning

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 the jf c add command. If not specified, the default configured Artifactory server is used.

| -| --spec |

[Optional]

Path to a file spec. For more details, please refer to Using File Specs.

| -| --spec-vars |

[Optional]

List 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 to Build Integration.

| -| --build-number |

[Optional]

Build number. For more details, please refer to Build Integration.

| -| --project |

[Optional]

JFrog project key.

| -| --module |

[Optional]

Optional module name for the build-info.

| -| --target-props |

[Optional]

A list of Artifactory properties specified 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".

| -| --deb |

[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.

If Using Placeholders are used, the value of this option is ignored.

Note

JFrog CLI v1

In 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. The symlink file 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. Bottom-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 --regexp and --ant options. Please read the --regexp and --ant options 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.

| -| --min-split |

[Default: 200]

The minimum file size in MiB required to attempt a multi-part upload. This option, as well as the functionality of multi-part upload, requires Artifactory with S3 storage.

| -| --split-count |

[Default: 5]

The maximum number of parts that can be concurrently uploaded per file during a multi-part upload. Set to 0 to disable multi-part upload. This option, as well as the functionality of multi-part upload, requires Artifactory with S3 storage.

| -| Command arguments |

The command takes two arguments.

In case the --spec option is used, the commands accept no arguments.

| +| Command arguments |

The command takes two arguments, source path and target path.

In case the --spec option is used, the commands accept no arguments.

| | Source path | The first argument specifies the local file system path to artifacts that should be uploaded to Artifactory. You can specify multiple artifacts by using wildcards or a regular expression as designated by the **--regexp** command option. Please read the **--regexp** option description for more information. | | Target path |

The second argument specifies the target path in Artifactory in the following format: [repository name]/[repository path]

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 to Using Placeholders.

| +| 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 the jf c add command. If not specified, the default configured Artifactory server is used.

| +| --spec |

[Optional]
Path to a file spec. For more details, please refer to Using File Specs.

| +| --spec-vars |

[Optional]
List 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 to Build Integration.

| +| --build-number |

[Optional]
Build number. For more details, please refer to Build Integration.

| +| --project |

[Optional]
JFrog project key.

| +| --module |

[Optional]
Optional module name for the build-info.

| +| --target-props |

[Optional]
A list of Artifactory properties specified 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".

| +| --deb |

[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 |

[Optional]
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.

If Using Placeholders are used, the value of this option is ignored.

Note

JFrog CLI v1

In 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 |

[Optional]
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 |

[Optional]
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 |

[Optional]
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 |

[Optional]
If true, the command will preserve the soft links structure in Artifactory. The symlink file representation will contain the symbolic link and checksum properties.

| +| --explode |

[Optional]
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 |

[Optional]
If true, the source path applies to bottom-chain directories and not only to files. Bottom-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 --regexp and --ant options. Please read the --regexp and --ant options 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 |

[Optional]
If true, the delete confirmation message is skipped.

| +| --fail-no-op |

[Optional]
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 |

[Optional]
Set to true to include a list of the affected files as part of the command output summary.

| +| --insecure-tls |

[Optional]
Set to true to skip TLS certificates verification.

| +| --min-split |

[Default: 200]
The minimum file size in MiB required to attempt a multi-part upload. This option, as well as the functionality of multi-part upload, requires Artifactory with S3 storage.

| +| --split-count |

[Default: 5]
The maximum number of parts that can be concurrently uploaded per file during a multi-part upload. Set to 0 to disable multi-part upload. This option, as well as the functionality of multi-part upload, requires Artifactory with S3 storage.

| ### Examples #### Example 1 @@ -109,51 +114,57 @@ This command is used to download files from Artifactory. > \ > By default, the command only downloads files that 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 the **JFROG\_CLI\_TRANSITIVE\_DOWNLOAD\_EXPERIMENTAL** environment variable to **true**. 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 that proxies non-Artifactory repositories is not supported. +### Usage + +```jf rt dl [command options] [Target path]``` +```jf rt dl --spec= [command options]``` + ### Commands Params | | | |-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Command name | rt download | | Abbreviation | rt dl | -| Command options |

Warning

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 to Build Integration.

| -| --build-number |

[Optional]

Build number. For more details, please refer to Build 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 to Using File Specs.

| -| --spec-vars |

[Optional]

List 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 Artifactory properties specified as "key=value" pairs separated by a semi-colon (for example, "key1=value1;key2=value2;key3=value3"). Only artifacts with all of the specified properties names and values will be downloaded.

| -| --exclude-props |

[Optional]

A list of Artifactory properties specified as "key=value" pairs separated by a semi-colon (for example, "key1=value1;key2=value2;key3=value3"). Only artifacts without all of 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.

If Using Placeholders are 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 --min-split in size). To download each file in a single thread, set to 0.

| -| --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 --split-count segments. Any files smaller than the specified number will be downloaded in a single thread. If set to -1, files are not split.

| -| --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.

| -| --bypass-archive-inspection |

[Default: false]

Set to true to bypass the archive security inspection before it is unarchived. Used with the 'explode' option.

| -| --validate-symlinks |

[Default: false]

If true, the command will validate that symlinks are 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. Bottom-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]

A list of semicolon-separated fields to sort by. The fields must be part of the 'items' AQL domain. For more information read the AQL 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 | | +| Command arguments |

The command takes two arguments source path and target path (Optional).

In case the --spec option is used, the commands accept no 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 to Using Placeholders.

| +| 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 to Build Integration.

| +| --build-number |

[Optional]
Build number. For more details, please refer to Build 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 to Using File Specs.

| +| --spec-vars |

[Optional]
List 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 Artifactory properties specified as "key=value" pairs separated by a semi-colon (for example, "key1=value1;key2=value2;key3=value3"). Only artifacts with all of the specified properties names and values will be downloaded.

| +| --exclude-props |

[Optional]
A list of Artifactory properties specified as "key=value" pairs separated by a semi-colon (for example, "key1=value1;key2=value2;key3=value3"). Only artifacts without all of 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 |

[Optional]
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.

If Using Placeholders are 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 --min-split in size). To download each file in a single thread, set to 0.

| +| --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 --split-count segments. Any files smaller than the specified number will be downloaded in a single thread. If set to -1, files are not split.

| +| --dry-run |

[Optional]
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 |

[Optional]
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.

| +| --bypass-archive-inspection |

[Optional]
Set to true to bypass the archive security inspection before it is unarchived. Used with the 'explode' option.

| +| --validate-symlinks |

[Optional]
If true, the command will validate that symlinks are pointing to existing and unchanged files, by comparing their sha1. Applicable to files and not directories.

| +| --include-dirs |

[Optional]
If true, the source path applies to bottom-chain directories and not only to files. Bottom-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 |

[Optional]
If true, the delete confirmation message is skipped.

| +| --sort-by |

[Optional]
A list of semicolon-separated fields to sort by. The fields must be part of the 'items' AQL domain. For more information read the AQL 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 |

[Optional]
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 |

[Optional]
Set to true to include a list of the affected files as part of the command output summary.

| +| --insecure-tls |

[Optional]
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.

| + ### Examples #### Example 1 @@ -192,36 +203,41 @@ jf rt dl "my-local-repo/all-my-frogs/" --sort-by=created --sort-order=desc --li This command is used to copy files in Artifactory +### Usage + +```jf rt cp [command options] ``` +```jf rt cp --spec= [command options]``` + ### Commands Params | | | |-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Command name | rt copy | | Abbreviation | rt cp | -| Command options |

Warning

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 to Using File Specs.

| -| --props |

[Optional]

A list of Artifactory properties specified as "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 Artifactory properties specified as "key=value" pairs separated by a semi-colon (for example, "key1=value1;key2=value2;key3=value3"). Only artifacts without all of 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]

A list of semicolon-separated fields to sort by. The fields must be part of the 'items' AQL domain. For more information read the AQL 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 | +| Command arguments |

The command takes two arguments source path and target path.

In case the --spec option is used, the commands accept no arguments.

| | Source path | Specifies the source path in Artifactory, from which the artifacts should be copied, in the following format: `[repository name]/[repository path].` You can use wildcards to specify multiple artifacts. | | Target path |

Specifies the target path in Artifactory, to which the artifacts should be copied, in the following format: [repository name]/[repository path]

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 to Using Placeholders.

| +| 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 to Using File Specs.

| +| --props |

[Optional]
A list of Artifactory properties specified as "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 Artifactory properties specified as "key=value" pairs separated by a semi-colon (for example, "key1=value1;key2=value2;key3=value3"). Only artifacts without all of 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 |

[Optional]
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 |

[Optional]
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]
A list of semicolon-separated fields to sort by. The fields must be part of the 'items' AQL domain. For more information read the AQL 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 |

[Optional]
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 |

[Optional]
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.

| ### Examples #### Example 1 @@ -252,36 +268,41 @@ jf rt cp "source-frog-repo/rabbit/*" target-frog-repo/rabbit/ --props=Version=1. This command is used to move files in Artifactory +### Usage + +```jf rt mv [command options] ``` +```jf rt mv --spec= [command options]``` + ### Commands Params | | | |-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Command name | rt move | | Abbreviation | rt mv | -| Command options |

Warning

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 to Using File Specs.

| -| --props |

[Optional]

A list of Artifactory properties specified as "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 Artifactory properties specified as "key=value" pairs separated by a semi-colon (for example, "key1=value1;key2=value2;key3=value3"). Only artifacts without all of 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]

A list of semicolon-separated fields to sort by. The fields must be part of the 'items' AQL domain. For more information read the AQL 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 | +| Command arguments |

The command takes two arguments source path and target path.

In case the --spec option is used, the commands accept no arguments.

| | Source path | Specifies the source path in Artifactory, from which the artifacts should be moved, in the following format: `[repository name]/[repository path].` You can use wildcards to specify multiple artifacts. | | Target path |

Specifies the target path in Artifactory, to which the artifacts should be moved, in the following format: [repository name]/[repository path]

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 to Using Placeholders.

| +| 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 to Using File Specs.

| +| --props |

[Optional]
A list of Artifactory properties specified as "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 Artifactory properties specified as "key=value" pairs separated by a semi-colon (for example, "key1=value1;key2=value2;key3=value3"). Only artifacts without all of 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 |

[Optional]
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 |

[Optional]
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]
A list of semicolon-separated fields to sort by. The fields must be part of the 'items' AQL domain. For more information read the AQL 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 |

[Optional]
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 |

[Optional]
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.

| ### Examples #### Example 1 @@ -312,35 +333,41 @@ jf rt mv "source-frog-repo/rabbit/*" target-frog-repo/rabbit/ --props=Version=1. This command is used to delete files in Artifactory +### Usage + +```jf rt del [command options] ``` +```jf rt del --spec= [command options]``` + ### Commands Params -| | | -|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Command name | rt delete | -| Abbreviation | rt del | -| Command options |

Warning

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 to Using File Specs.

| -| --props |

[Optional]

A list of Artifactory properties specified as "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 Artifactory properties specified as "key=value" pairs separated by a semi-colon (for example, "key1=value1;key2=value2;key3=value3"). Only artifacts without all of 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]

A list of semicolon-separated fields to sort by. The fields must be part of the 'items' AQL domain. For more information read the AQL 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.--retry-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: `[repository name]/[repository path].` You can use wildcards to specify multiple artifacts. | +| | | +|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Command name | rt delete | +| Abbreviation | rt del | +| Command arguments |

The command takes one argument which is the delete path.

In case the --spec option is used, the commands accept no arguments.

| +| Delete path | Specifies the path in Artifactory of the files that should be deleted in the following format: `[repository name]/[repository path].` You can use wildcards to specify multiple artifacts. | +| 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 to Using File Specs.

| +| --props |

[Optional]
A list of Artifactory properties specified as "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 Artifactory properties specified as "key=value" pairs separated by a semi-colon (for example, "key1=value1;key2=value2;key3=value3"). Only artifacts without all of 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 |

[Optional]
If true, the delete confirmation message is skipped.

| +| --dry-run |

[Optional]
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]
A list of semicolon-separated fields to sort by. The fields must be part of the 'items' AQL domain. For more information read the AQL 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 |

[Optional]
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 |

[Optional]
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

| + ### Examples #### Example 1 @@ -363,37 +390,43 @@ jf rt del "frog-repo/rabbit/*.zip" This command is used to search and display files in Artifactory. +### Usage + +```jf rt s [command options] ``` +```jf rt s --spec= [command options]``` + + ### Commands Params -| | | -|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Command name | rt search | -| Abbreviation | rt s | -| Command options |

Warning

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 to Using File Specs.

| -| --count |

[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]

List 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 Artifactory properties specified as "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 Artifactory properties specified as "key=value" pairs separated by a semi-colon (for example, "key1=value1;key2=value2;key3=value3"). Only artifacts without all of 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]

A list of semicolon-separated fields to sort by. The fields must be part of the 'items' AQL domain. For more information read the AQL 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

| -| --include |

[Optional]

List of fields in the form of "value1;value2;...".
Only the path and the fields that are specified will be returned. The fields must be part of the 'items' AQL domain. for the full supported items list check AQL documentation

| -| Command arguments | | -| Search path | Specifies the search path in Artifactory, in the following format: `[repository name]/[repository path].` You can use wildcards to specify multiple artifacts. | +| | | +|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Command name | rt search | +| Abbreviation | rt s | +| Command arguments |

The command takes one argument which is the search path.

In case the --spec option is used, the commands accept no arguments.

| +| Search path | Specifies the search path in Artifactory, in the following format: `[repository name]/[repository path].` You can use wildcards to specify multiple artifacts. | +| 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 to Using File Specs.

| +| --count |

[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]
List 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 Artifactory properties specified as "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 Artifactory properties specified as "key=value" pairs separated by a semi-colon (for example, "key1=value1;key2=value2;key3=value3"). Only artifacts without all of 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]
A list of semicolon-separated fields to sort by. The fields must be part of the 'items' AQL domain. For more information read the AQL documentation

| +| --sort-order |

[Default: asc]
The order by which fields in the 'sort-by' option should be sorted. Accepts 'asc' or 'desc'.

| +| --transitive |

[Optional]
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 |

[Optional]
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 |

[Optional]
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

| +| --include |

[Optional]
List of fields in the form of "value1;value2;...".
Only the path and the fields that are specified will be returned. The fields must be part of the 'items' AQL domain. for the full supported items list check AQL documentation

| ### Examples #### Example 1 @@ -424,36 +457,41 @@ jf rt s example-repo-local --include="actual_md5;modified_by;updated;depth" This command is used for setting properties on existing files in Artifactory. +### Usage + +```jf rt sp [command options] ``` +```jf rt sp --spec= [command options]``` + ### Commands Params -| | | -|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Command name | rt set-props | -| Abbreviation | rt sp | -| Command options |

Warning

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 to Using File Specs.

| -| --spec-vars |

[Optional]

List 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]

List 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 Artifactory properties specified as "key=value" pairs separated by a semi-colon (for example, "key1=value1;key2=value2;key3=value3"). Only artifacts without all of 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]

A list of semicolon-separated fields to sort by. The fields must be part of the 'items' AQL domain. For more information read the AQL 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. | +| | | +|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Command name | rt set-props | +| Abbreviation | rt sp | +| Command arguments |

The command takes two arguments, files pattern and files properties.

In case the --spec option is used, the commands accept no 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. | +| 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 to Using File Specs.

| +| --spec-vars |

[Optional]
List 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]
List 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 Artifactory properties specified as "key=value" pairs separated by a semi-colon (for example, "key1=value1;key2=value2;key3=value3"). Only artifacts without all of 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 |

[Optional]
When true, the properties will also be set on folders (and not just files) in Artifactory.

| +| --fail-no-op |

[Optional]
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]
A list of semicolon-separated fields to sort by. The fields must be part of the 'items' AQL domain. For more information read the AQL 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 |

[Optional]
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.

| ### Examples #### Example 1 @@ -476,33 +514,38 @@ jf rt sp "a=1;b=2,3" --spec my-spec This command is used for deleting properties from existing files in Artifactory. +### Usage + +```jf rt delp [command options] ``` +```jf rt delp --spec= [command options]``` + ### Commands Params -| | | -|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Command name | rt delete-props | -| Abbreviation | rt delp | -| Command options |

Warning

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]

List of properties in the form of "key1=value1;key2=value2,...". Only files with these properties are affected.

| -| --exclude-props |

[Optional]

A list of Artifactory properties specified as "key=value" pairs separated by a semi-colon (for example, "key1=value1;key2=value2;key3=value3"). Only artifacts without all of 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]

A list of semicolon-separated fields to sort by. The fields must be part of the 'items' AQL domain. For more information read the AQL 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.

| -| --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 | 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. | +| | | +|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Command name | rt delete-props | +| Abbreviation | rt delp | +| Command arguments |

The command takes two arguments, files pattern and files properties.

In case the --spec option is used, the commands accept no 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. | +| 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]
List of properties in the form of "key1=value1;key2=value2,...". Only files with these properties are affected.

| +| --exclude-props |

[Optional]
A list of Artifactory properties specified as "key=value" pairs separated by a semi-colon (for example, "key1=value1;key2=value2;key3=value3"). Only artifacts without all of 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 |

[Optional]
When true, the properties will also be set on folders (and not just files) in Artifactory.

| +| --fail-no-op |

[Optional]
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]
A list of semicolon-separated fields to sort by. The fields must be part of the 'items' AQL domain. For more information read the AQL 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 |

[Optional]
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

| ### Example diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/managing-configuration-entities.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/managing-configuration-entities.md index be8c0a6..3e00073 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/managing-configuration-entities.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/managing-configuration-entities.md @@ -19,16 +19,16 @@ The CSV can include additional columns, with different headers, which will be ig ### Commands Params -| | | -|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------| -| Command-name | rt users-create | -| 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 | +| | | +|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------| +| Command-name | rt users-create | +| 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 @@ -55,15 +55,15 @@ The CSV can include additional columns, with different headers, which will be ig ### Commands Params -| | | -|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| 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. | +| | | +|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 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. | ### Examples #### Example 1 @@ -88,14 +88,14 @@ This command creates a new users group. ### Commands Params -| | | -|-------------------|-------------------------------------------------------------------------------------| -| 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. | +| | | +|-------------------|---------------------------------------------------------------------------------| +| 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 @@ -111,15 +111,15 @@ This command adds a list fo existing users to a group. ### Commands Params -| | | -|-------------------|-------------------------------------------------------------------------------------| -| 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. | +| | | +|-------------------|---------------------------------------------------------------------------------| +| 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 @@ -135,14 +135,14 @@ This command deletes a group. ### Commands Params -| | | -|-------------------|-------------------------------------------------------------------------------------| -| 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. | +| | | +|-------------------|---------------------------------------------------------------------------------| +| 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 @@ -198,15 +198,15 @@ These two commands create a new repository and updates an existing a repository. #### Commands Params -| | | -|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| 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]

List 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. | +| | | +|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 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]
List 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. | #### Examples ##### Example 1 @@ -244,8 +244,8 @@ This command permanently deletes a repository, including all of its content. | Command name | 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.

| +| --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. | @@ -302,15 +302,15 @@ This command creates a new replication job for a repository. The command accepts #### Commands Params -| | | -|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Command-name | replication-create | -| Abbreviation | rt rplc | -| Command options | | -| --server-id |

[Optional]

Artifactory server ID configured using the config command.

| -| --vars |

[Optional]

List 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. | +| | | +|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Command-name | replication-create | +| Abbreviation | rt rplc | +| Command options | | +| --server-id |

[Optional]
Artifactory server ID configured using the config command.

| +| --vars |

[Optional]
List 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. | #### Examples ##### Example 1 @@ -335,15 +335,15 @@ This command permanently deletes a replication jobs from a repository. #### Commands Params -| | | -|-------------------|-------------------------------------------------------------------------------------| -| Command name | rt replication-delete | -| Abbreviation | rt rpldel | -| 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 | The repository from which the replications will be deleted. | +| | | +|-------------------|---------------------------------------------------------------------------------| +| Command name | rt replication-delete | +| Abbreviation | rt rpldel | +| 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 | The repository from which the replications will be deleted. | #### Example @@ -373,26 +373,26 @@ This command creates a configuration template file, which should be used as an a This command creates a new permission target. The command accepts as an argument a configuration template, which can be created by the **jf rt permission-target-template** command. 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]

List 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. | +| | | +|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 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]
List 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. -| | | -|------------------------|-------------------------------------------------------------------------------------| -| Command name | rt permission-target-delete | -| Abbreviation | rt ptdel | -| 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 | | -| permission target name | The permission target that should be removed. | +| | | +|------------------------|---------------------------------------------------------------------------------| +| Command name | rt permission-target-delete | +| Abbreviation | rt ptdel | +| 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 | | +| permission target name | The permission target that should be removed. | diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/package-managers-integration.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/package-managers-integration.md index 8ad38c0..f8cdf76 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/package-managers-integration.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/package-managers-integration.md @@ -9,23 +9,23 @@ JFrog CLI includes integration with Maven, allowing you to resolve dependencies Before using the **jf mvn** command, the project needs to be pre-configured with the Artifactory server and repositories, to be used for building and publishing the project. The **jf mvn-config** command 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 **.jfrog** directory 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 | +| | | +|--------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 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 |

[Optional]
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 @@ -39,17 +39,17 @@ The **mvn** command triggers the maven client, while resolving dependencies and 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 to Build Integration.

| -| --build-number |

[Optional]

Build number. For more details, please refer to Build 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. | +| | | +|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 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 to Build Integration.

| +| --build-number |

[Optional]
Build number. For more details, please refer to Build Integration.

| +| --project |

[Optional]
JFrog project key.

| +| --insecure-tls |

[Optional]
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 @@ -72,25 +72,25 @@ JFrog CLI includes integration with Gradle, allowing you to resolve dependencies Before using the **gradle** command, the project needs to be pre-configured with the Artifactory server and repositories, to be used for building and publishing the project. The **gradle-config** command 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\*\*.jfrog\*\* directory 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 | +| | | +|-------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 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 |

[Optional]
Set to true if the Gradle Artifactory Plugin is already applied in the build script.

| +| --use-wrapper |

[Optional]
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 |

[Optional]
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 @@ -104,16 +104,16 @@ The **jf gradle** command triggers the gradle client, while resolving dependenci 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 to Build Integration.

| -| --build-number |

[Optional]

Build number. For more details, please refer to Build Integration.

| -| --project |

[Optional]

JFrog project key.

| -| Command arguments | The command accepts the same arguments and options as the gradle client. | +| | | +|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 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 to Build Integration.

| +| --build-number |

[Optional]
Build number. For more details, please refer to Build Integration.

| +| --project |

[Optional]
JFrog project key.

| +| Command arguments | The command accepts the same arguments and options as the gradle client. | #### Example @@ -172,18 +172,18 @@ Running **jf docker pull** command allows pulling docker images from Artifactory 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 to Build Integration.

| -| --build-number |

[Optional]

Build number. For more details, please refer to Build 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/ | +| | | +|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 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 to Build Integration.

| +| --build-number |

[Optional]
Build number. For more details, please refer to Build Integration.

| +| --project |

[Optional]
JFrog project key.

| +| --module |

[Optional]
Optional module name for the build-info.

| +| --skip-login |

[Optional]
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/ | #### Example @@ -203,20 +203,20 @@ After building your image using the docker client, the **jf docker push** comman 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 to Build Integration.

| -| --build-number |

[Optional]

Build number. For more details, please refer to Build 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/ | +| | | +|--------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 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 to Build Integration.

| +| --build-number |

[Optional]
Build number. For more details, please refer to Build Integration.

| +| --project |

[Optional]
JFrog project key.

| +| --module |

[Optional]
Optional module name for the build-info.

| +| --skip-login |

[Optional]
Set to true if you'd like the command to skip performing docker login.

| +| --threads |

[Default: 3]
Number of working threads.

| +| --detailed-summary |

[Optional]
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/ | #### Example @@ -236,20 +236,20 @@ You can then publish the build-info collected by the **docker-push** command to 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 to Build Integration.

| -| --build-number |

[Optional]

Build number. For more details, please refer to Build 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. | +| | | +|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 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 to Build Integration.

| +| --build-number |

[Optional]
Build number. For more details, please refer to Build Integration.

| +| --project |

[Optional]
JFrog project key.

| +| --module |

[Optional]
Optional module name for the build-info.

| +| --skip-login |

[Optional]
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. | #### Example @@ -269,22 +269,22 @@ You can then publish the build-info collected by the **podman-pull** command to 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 to Build Integration.

| -| --build-number |

[Optional]

Build number. For more details, please refer to Build 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. | +| | | +|--------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 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 to Build Integration.

| +| --build-number |

[Optional]
Build number. For more details, please refer to Build Integration.

| +| --project |

[Optional]
JFrog project key.

| +| --module |

[Optional]
Optional module name for the build-info.

| +| --skip-login |

[Optional]
Set to true if you'd like the command to skip performing docker login.

| +| --threads |

[Default: 3]
Number of working threads.

| +| --detailed-summary |

[Optional]
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. | #### Example @@ -323,13 +323,13 @@ The **build-docker-create** command allows adding a docker image, which is alrea | 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 to Build Integration.

| -| --build-number |

[Optional]

Build number. For more details, please refer to Build 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.

| +| --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 to Build Integration.

| +| --build-number |

[Optional]
Build number. For more details, please refer to Build Integration.

| +| --project |

[Optional]
JFrog project key.

| +| --module |

[Optional]
Optional module name for the build-info.

| +| --skip-login |

[Optional]
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. | @@ -354,20 +354,20 @@ Promotion is the action of moving or copying a group of artifacts from one repos 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. | +| | | +|-----------------------|------------------------------------------------------------------------------------------------------------------------------------------| +| 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 |

[Optional]
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 @@ -396,17 +396,17 @@ Artifactory version 5.5.2 and above. Before using the **jf npm install**, **jf npm ci** and **jf npm publish** commands, the project needs to be pre-configured with the Artifactory server and repositories, to be used for building and publishing the project. The **jf npm-config** command 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 **.jfrog** directory 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 '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.

| -| Command arguments | The command accepts no arguments | +| | | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 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 '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.

| +| Command arguments | The command accepts no arguments | ### Installing Npm Packages @@ -418,20 +418,20 @@ Before running the **jf npm install** or **jf npm ci** command on a project for 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 to Build Integration.

| -| --build-number |

[Optional]

Build number. For more details, please refer to Build 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. | -| --project |

[Optional]

JFrog project key.

| -| --module |

[Optional]

Optional module name for the build-info.

| -| Command arguments | The command accepts the same arguments and options as the npm client. | +| | | +|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Command-name | npm | +| Abbreviation | | +| Command options | | +| --build-name |

[Optional]
Build name. For more details, please refer to Build Integration.

| +| --build-number |

[Optional]
Build number. For more details, please refer to Build 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. | +| --project |

[Optional]
JFrog project key.

| +| --module |

[Optional]
Optional module name for the build-info.

| +| Command arguments | The command accepts the same arguments and options as the npm client. | #### Examples ##### Example 1 @@ -470,19 +470,19 @@ Before running the **npm-publish** command on a project for the first time, the 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 to Build Integration.

| -| --build-number |

[Optional]

Build number. For more details, please refer to Build 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 the **npm pack** command expects. | +| | | +|--------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Command-name | npm publish | +| Abbreviation | | +| Command options | | +| --build-name |

[Optional]
Build name. For more details, please refer to Build Integration.

| +| --build-number |

[Optional]
Build number. For more details, please refer to Build Integration.

| +| --project |

[Optional]
JFrog project key.

| +| --module |

[Optional]
Optional module name for the build-info.

| +| --detailed-summary |

[Optional]
Set true to include a list of the affected files as part of the command output summary.

| +| --scan |

[Optional]
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 the **npm pack** command expects. | #### Example @@ -502,15 +502,15 @@ Yarn version 2.4.0 and above is supported. Before using the **jf yarn** command, the project needs to be pre-configured with the Artifactory server and repositories, to be used for building the project. The **yarn-config** command 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 **.jfrog** directory 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 | +| | | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 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 | ### Installing Npm Packages @@ -522,16 +522,16 @@ The **jf yarn** command executes the yarn client, to fetch the npm dependencies The following table lists the command arguments and flags: -| | | -|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Command-name | yarn | -| Command options | | -| --build-name |

[Optional]

Build name. For more details, please refer to Build Integration.

| -| --build-number |

[Optional]

Build number. For more details, please refer to Build 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. | +| | | +|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Command-name | yarn | +| Command options | | +| --build-name |

[Optional]
Build name. For more details, please refer to Build Integration.

| +| --build-number |

[Optional]
Build number. For more details, please refer to Build 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 @@ -579,16 +579,16 @@ Here's how you set the repositories. #### Commands Params -| | | -|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| 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.

| +| | | +|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 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 @@ -617,18 +617,18 @@ The **go** command triggers the go client. 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 to Build Integration.

| -| --build-number |

[Optional]

Build number. For more details, please refer to Build 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. | +| | | +|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Command-name | go | +| Abbreviation | go | +| Command options | | +| --build-name |

[Optional]
Build name. For more details, please refer to Build Integration.

| +| --build-number |

[Optional]
Build number. For more details, please refer to Build Integration.

| +| --project |

[Optional]
JFrog project key.

| +| --no-fallback |

[Optional]
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 @@ -661,18 +661,18 @@ The **jf go-publish** command packs and deploys the Go package to the designated 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 to Build Integration.

| -| --build-number |

[Optional]

Build number. For more details, please refer to Build 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 | +| | | +|--------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Command-name | go-publish | +| Abbreviation | gp | +| Command options | | +| --build-name |

[Optional]
Build name. For more details, please refer to Build Integration.

| +| --build-number |

[Optional]
Build number. For more details, please refer to Build Integration.

| +| --project |

[Optional]
JFrog project key.

| +| --module |

[Optional]
Optional module name for the build-info.

| +| --detailed-summary |

[Optional]
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 @@ -712,14 +712,14 @@ Here's how you set the repositories. #### Commands Params -| | | -|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| 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.

| +| | | +|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 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 @@ -789,16 +789,16 @@ Running the 'install' command with both the **no-cache-dir** and **force-reinsta #### Commands Params -| | | -|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Command-name | pip / pipenv / poetry | -| Abbreviation | | -| Command options | | -| --build-name |

[Optional]

Build name. For more details, please refer to Build Integration.

| -| --build-number |

[Optional]

Build number. For more details, please refer to Build 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 pip / pipenv / poetry clients. | +| | | +|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Command-name | pip / pipenv / poetry | +| Abbreviation | | +| Command options | | +| --build-name |

[Optional]
Build name. For more details, please refer to Build Integration.

| +| --build-number |

[Optional]
Build number. For more details, please refer to Build 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 pip / pipenv / poetry clients. | #### Examples ##### Example 1 @@ -842,16 +842,16 @@ Before using the nuget or dotnet commands, the **nuget-config** or **dotnet-conf 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]
Set to true if you'd like to use the NuGet V2 protocol when restoring packages from Artifactory (instead of NuGet V3).

| -| Command arguments | The command accepts no arguments | +| | | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 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]
Set to true if you'd like to use the NuGet V2 protocol when restoring packages from Artifactory (instead of NuGet V3).

| +| Command arguments | The command accepts no arguments | ### Running Nuget and Dotnet commands @@ -865,16 +865,16 @@ The **nuget** command runs the **NuGet client** and the **dotnet** command runs 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 to Build Integration.

| -| --build-number |

[Optional]

Build number. For more details, please refer to Build 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. | +| | | +|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Command-name | nuget / dotnet | +| Abbreviation | | +| Command options | | +| --build-name |

[Optional]
Build name. For more details, please refer to Build Integration.

| +| --build-number |

[Optional]
Build number. For more details, please refer to Build 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 @@ -923,15 +923,15 @@ The **jf terraform-config** command will store the repository name inside the ** 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 | +| | | +|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 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 @@ -958,19 +958,19 @@ The **terraform publish** command creates a terraform package for the module in 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 patterns wildcards. 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 to Build Integration.

| -| --build-number |

[Optional]

Build number. For more details, please refer to Build Integration.

| -| --project | | -| Command argument | The command accepts no arguments | +| | | +|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 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 patterns wildcards. 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 to Build Integration.

| +| --build-number |

[Optional]
Build number. For more details, please refer to Build Integration.

| +| --project | | +| Command argument | The command accepts no arguments | #### Examples ##### Example 1 diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/release-lifecycle-management.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/release-lifecycle-management.md index 173024a..13f45a7 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/release-lifecycle-management.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/release-lifecycle-management.md @@ -99,12 +99,12 @@ The file spec may be of one of the following creation sources: | Command-name | release-bundle-create | | Abbreviation | rbc | | Command options | | -| --project |

[Optional]

Project key associated with the created Release Bundle version.

| -| --server-id |

[Optional]

Platform server ID configured using the config command.

| -| --signing-key |

[Mandatory]

The GPG/RSA key-pair name given in Artifactory.

| -| --spec |

[Optional]

Path to a File Spec.

| -| --spec-vars |

[Optional]

List of variables in the form of "key1=value1;key2=value2;..." (wrapped by quotes) to be replaced in the File Spec. In the File Spec, the variables should be used as follows: ${key1}.

| -| --sync |

[Default: false]

Set to true to run synchronously.

| +| --project |

[Optional]
Project key associated with the created Release Bundle version.

| +| --server-id |

[Optional]
Platform server ID configured using the config command.

| +| --signing-key |

[Mandatory]
The GPG/RSA key-pair name given in Artifactory.

| +| --spec |

[Optional]
Path to a File Spec.

| +| --spec-vars |

[Optional]
List of variables in the form of "key1=value1;key2=value2;..." (wrapped by quotes) to be replaced in the File Spec. In the File Spec, the variables should be used as follows: ${key1}.

| +| --sync |

[Optional]
Set to true to run synchronously.

| | Command arguments | | | release bundle name | Name of the newly created Release Bundle. | | release bundle version | Version of the newly created Release Bundle. | @@ -145,12 +145,12 @@ This command allows promoting a release bundle to a target environment. | Command-name | release-bundle-promote | | Abbreviation | rbp | | Command options | | -| --input-repos |

[Optional]

A list of semicolon-separated repositories to include in the promotion. If this property is left undefined, all repositories (except those specifically excluded) are included in the promotion. If one or more repositories are specifically included, all other repositories are excluded.

| -| --exclude-repos |

[Optional]

A list of semicolon-separated repositories to exclude from the promotion.

| -| --project |

[Optional]

Project key associated with the Release Bundle version.

| -| --server-id |

[Optional]

Platform server ID configured using the config command.

| -| --signing-key |

[Mandatory]

The GPG/RSA key-pair name given in Artifactory.

| -| --sync |

[Default: false]

Set to true to run synchronously.

| +| --input-repos |

[Optional]
A list of semicolon-separated repositories to include in the promotion. If this property is left undefined, all repositories (except those specifically excluded) are included in the promotion. If one or more repositories are specifically included, all other repositories are excluded.

| +| --exclude-repos |

[Optional]
A list of semicolon-separated repositories to exclude from the promotion.

| +| --project |

[Optional]
Project key associated with the Release Bundle version.

| +| --server-id |

[Optional]
Platform server ID configured using the config command.

| +| --signing-key |

[Mandatory]
The GPG/RSA key-pair name given in Artifactory.

| +| --sync |

[Optional]
Set to true to run synchronously.

| | Command arguments | | | release bundle name | Name of the Release Bundle to promote. | | release bundle version | Version of the Release Bundle to promote. | @@ -198,18 +198,18 @@ This command distributes a release bundle to an edge node. | Command-name | release-bundle-distribute | | Abbreviation | rbd | | Command options | | -| --city |

[Default: *]

Wildcard filter for site city name.

| -| --country-codes |

[Default: *]

Semicolon-separated list of wildcard filters for site country codes.

| -| --create-repo |

[Default: false]

Set to true to create the repository on the edge if it does not exist.

| -| --dist-rules |

[Optional]

Path to a file, which includes the Distribution Rules in a JSON format. See the "Distribution Rules Structure" bellow.

| -| --dry-run |

[Default: false]

Set to true to disable communication with JFrog Distribution.

| -| --mapping-pattern |

[Optional]

Specify along with 'mapping-target' to distribute artifacts to a different path on the edge node. You can use wildcards to specify multiple artifacts.

| -| --mapping-target |

[Optional]

The target path for distributed artifacts on the edge node. If not specified, the artifacts will have the same path and name on the edge node, as on the source Artifactory server. For flexibility in specifying the distribution path, you can include [placeholders](https://www.jfrog.com/confluence/display/CLI/CLI+for+JFrog+Artifactory#CLIforJFrogArtifactory-UsingPlaceholders) in the form of {1}, {2} which are replaced by corresponding tokens in the pattern path that are enclosed in parenthesis.

| -| --max-wait-minutes |

[Default: 60]

Max minutes to wait for sync distribution.

| -| --project |

[Optional]

Project key associated with the Release Bundle version.

| -| --server-id |

[Optional]

Platform server ID configured using the config command.

| -| --site |

[Default: *]

Wildcard filter for site name.

| -| --sync |

[Default: false]

Set to true to run synchronously.

| +| --city |

[Default: *]
Wildcard filter for site city name.

| +| --country-codes |

[Default: *]
Semicolon-separated list of wildcard filters for site country codes.

| +| --create-repo |

[Optional]
Set to true to create the repository on the edge if it does not exist.

| +| --dist-rules |

[Optional]
Path to a file, which includes the Distribution Rules in a JSON format. See the "Distribution Rules Structure" bellow.

| +| --dry-run |

[Optional]
Set to true to disable communication with JFrog Distribution.

| +| --mapping-pattern |

[Optional]
Specify along with 'mapping-target' to distribute artifacts to a different path on the edge node. You can use wildcards to specify multiple artifacts.

| +| --mapping-target |

[Optional]
The target path for distributed artifacts on the edge node. If not specified, the artifacts will have the same path and name on the edge node, as on the source Artifactory server. For flexibility in specifying the distribution path, you can include [placeholders](https://www.jfrog.com/confluence/display/CLI/CLI+for+JFrog+Artifactory#CLIforJFrogArtifactory-UsingPlaceholders) in the form of {1}, {2} which are replaced by corresponding tokens in the pattern path that are enclosed in parenthesis.

| +| --max-wait-minutes |

[Default: 60]
Max minutes to wait for sync distribution.

| +| --project |

[Optional]
Project key associated with the Release Bundle version.

| +| --server-id |

[Optional]
Platform server ID configured using the config command.

| +| --site |

[Default: *]
Wildcard filter for site name.

| +| --sync |

[Optional]
Set to true to run synchronously.

| | Command arguments | | | release bundle name | Name of the release bundle to distribute. | | release bundle version | Version of the release bundle to distribute. | @@ -272,10 +272,10 @@ Deleting locally means distributions of the release bundle will not be deleted. | Command-name | release-bundle-delete-local | | Abbreviation | rbdell | | Command options | | -| --project |

[Optional]

Project key associated with the Release Bundle version.

| -| --quiet |

[Default: $CI]

Set to true to skip the delete confirmation message.

| -| --server-id |

[Optional]

Platform server ID configured using the config command.

| -| --sync |

[Default: false]

Set to true to run synchronously.

| +| --project |

[Optional]
Project key associated with the Release Bundle version.

| +| --quiet |

[Default: $CI]
Set to true to skip the delete confirmation message.

| +| --server-id |

[Optional]
Platform server ID configured using the config command.

| +| --sync |

[Optional]
Set to true to run synchronously.

| | Command arguments | | | release bundle name | Name of the release bundle to distribute. | | release bundle version | Version of the release bundle to distribute. | @@ -306,16 +306,16 @@ This command will delete distributions of a release bundle from edge nodes. | Command-name | release-bundle-delete-remote | | Abbreviation | rbdelr | | Command options | | -| --city |

[Default: *]

Wildcard filter for site city name.

| -| --country-codes |

[Default: *]

Semicolon-separated list of wildcard filters for site country codes.

| -| --dist-rules |

[Optional]

Path to a file, which includes the Distribution Rules in a JSON format. See the "Distribution Rules Structure" bellow.

| -| --dry-run |

[Default: false]

Set to true to disable communication with JFrog Distribution.

| -| --max-wait-minutes |

[Default: 60]

Max minutes to wait for sync distribution.

| -| --project |

[Optional]

Project key associated with the Release Bundle version.

| -| --quiet |

[Default: $CI]

Set to true to skip the delete confirmation message.

| -| --server-id |

[Optional]

Platform server ID configured using the config command.

| -| --site |

[Default: *]

Wildcard filter for site name.

| -| --sync |

[Default: false]

Set to true to run synchronously.

| +| --city |

[Default: *]
Wildcard filter for site city name.

| +| --country-codes |

[Default: *]
Semicolon-separated list of wildcard filters for site country codes.

| +| --dist-rules |

[Optional]
Path to a file, which includes the Distribution Rules in a JSON format. See the "Distribution Rules Structure" bellow.

| +| --dry-run |

[Optional]
Set to true to disable communication with JFrog Distribution.

| +| --max-wait-minutes |

[Default: 60]
Max minutes to wait for sync distribution.

| +| --project |

[Optional]
Project key associated with the Release Bundle version.

| +| --quiet |

[Default: $CI]
Set to true to skip the delete confirmation message.

| +| --server-id |

[Optional]
Platform server ID configured using the config command.

| +| --site |

[Default: *]
Wildcard filter for site name.

| +| --sync |

[Optional]
Set to true to run synchronously.

| | Command arguments | | | release bundle name | Name of the release bundle to distribute. | | release bundle version | Version of the release bundle to distribute. | diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/verifying-artifactory-accessibility.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/verifying-artifactory-accessibility.md index 703ee7c..8fb697e 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/verifying-artifactory-accessibility.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/verifying-artifactory-accessibility.md @@ -4,16 +4,16 @@ This command can be used to verify that Artifactory is accessible by sending an ## Commands Params -| | | -|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Command name | rt ping | -| Abbreviation | rt p | -| | | -| Command options | | -| --url |

[Optional]

Artifactory URL.

| -| --server-id |

[Optional]

Server ID configured using the jf c add command. 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. | +| | | +|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Command name | rt ping | +| Abbreviation | rt p | +| | | +| Command options | | +| --url |

[Optional]
Artifactory URL.

| +| --server-id |

[Optional]
Server ID configured using the jf c add command. If not specified, the default configured Artifactory server is used.

| +| --insecure-tls |

[Optional]
Set to true to skip TLS certificates verification.

| +| Command arguments | The command accepts no arguments. | ## Examples ### Example 1 diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-curation.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-curation.md index f0e64b3..19f2975 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-curation.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-curation.md @@ -35,14 +35,14 @@ Before running the command, do the following: #### Commands Params -| | | -|---------------------|----------------------------------------------------------------------------------------------------------------------------------------| -| **Command name** | curation-audit | -| **Abbreviation** | ca | -| **Command options** | | -| --format |

[Default: table]

Defines the output format of the command. Acceptable values are: table and json.

| -| --working-dirs |

[Optional]

A comma separated list of relative working directories, to determine the audit targets locations.

| -| --threads |

[Default: 10]

The number of parallel threads used to determine the curation status for each package in the project tree.

| +| | | +|---------------------|------------------------------------------------------------------------------------------------------------------------------------| +| **Command name** | curation-audit | +| **Abbreviation** | ca | +| **Command options** | | +| --format |

[Default: table]
Defines the output format of the command. Acceptable values are: table and json.

| +| --working-dirs |

[Optional]
A comma separated list of relative working directories, to determine the audit targets locations.

| +| --threads |

[Default: 10]
The number of parallel threads used to determine the curation status for each package in the project tree.

| #### Example 1 diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-distribution.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-distribution.md index 6c94740..50ce4b8 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-distribution.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-distribution.md @@ -34,30 +34,30 @@ This commands creates and updates an unsigned Release Bundle on JFrog Distributi #### Commands Params -| | | -|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Command-name | release-bundle-create / release-bundle-update | -| Abbreviation | rbc / rbu | -| Command options | | -| --server-id |

[Optional]

Artifactory server ID configured using the config command.

| -| --spec |

[Optional]

Path to a file spec. For more details, please refer to Using File Specs.

| -| --spec-vars |

[Optional]

List 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}.

| -| --target-props |

[Optional]

The list of properties, in the form of key1=value1;key2=value2,..., to be added to the artifacts after distribution of the release bundle.

| -| --target |

[Optional]

The target path for distributed artifacts on the edge node. If not specified, the artifacts will have the same path and name on the edge node, as on the source Artifactory server. For flexibility in specifying the distribution path, you can include placeholders in the form of {1}, {2} which are replaced by corresponding tokens in the pattern path that are enclosed in parenthesis.

| -| --dry-run |

[Default: false]

Set to true to disable communication with JFrog Distribution.

| -| --sign |

[Default: false]

If set to true, automatically signs the release bundle version.

| -| --passphrase |

[Optional]

The passphrase for the signing key.

| -| --desc |

[Optional]

Description of the release bundle.

| -| --release-notes-path |

[Optional]

Path to a file describes the release notes for the release bundle version.

| -| --release-notes-syntax |

[Default: plain_text]

The syntax for the release notes. Can be one of markdown, asciidoc, or plain_text.

| -| --exclusions |

[Optional]

A list of Semicolon-separated exclude path patterns, to be excluded from the Release Bundle. Allows using wildcards.

| -| --repo |

[Optional]

A repository name at source Artifactory to store release bundle artifacts in. If not provided, Artifactory will use the default one.

| -| --insecure-tls |

[Default: false]

Set to true to skip TLS certificates verification.

| -| --detailed-summary |

[Default: false]

Set to true to return the SHA256 value of the release bundle manifest.

| -| Command arguments | | -| release bundle name | The name of the release bundle. | -| release bundle version | The release bundle version. | -| pattern | Specifies the source path in Artifactory, from which the artifacts should be bundled, in the following format: \/\. You can use wildcards to specify multiple artifacts. This argument should not be sent along with the _--spec_ option. | +| | | +|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Command-name | release-bundle-create / release-bundle-update | +| Abbreviation | rbc / rbu | +| Command options | | +| --server-id |

[Optional]
Artifactory server ID configured using the config command.

| +| --spec |

[Optional]
Path to a file spec. For more details, please refer to Using File Specs.

| +| --spec-vars |

[Optional]
List 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}.

| +| --target-props |

[Optional]
The list of properties, in the form of key1=value1;key2=value2,..., to be added to the artifacts after distribution of the release bundle.

| +| --target |

[Optional]
The target path for distributed artifacts on the edge node. If not specified, the artifacts will have the same path and name on the edge node, as on the source Artifactory server. For flexibility in specifying the distribution path, you can include placeholders in the form of {1}, {2} which are replaced by corresponding tokens in the pattern path that are enclosed in parenthesis.

| +| --dry-run |

[Optional]
Set to true to disable communication with JFrog Distribution.

| +| --sign |

[Optional]
If set to true, automatically signs the release bundle version.

| +| --passphrase |

[Optional]
The passphrase for the signing key.

| +| --desc |

[Optional]
Description of the release bundle.

| +| --release-notes-path |

[Optional]
Path to a file describes the release notes for the release bundle version.

| +| --release-notes-syntax |

[Default: plain_text]
The syntax for the release notes. Can be one of markdown, asciidoc, or plain_text.

| +| --exclusions |

[Optional]
A list of Semicolon-separated exclude path patterns, to be excluded from the Release Bundle. Allows using wildcards.

| +| --repo |

[Optional]
A repository name at source Artifactory to store release bundle artifacts in. If not provided, Artifactory will use the default one.

| +| --insecure-tls |

[Optional]
Set to true to skip TLS certificates verification.

| +| --detailed-summary |

[Optional]
Set to true to return the SHA256 value of the release bundle manifest.

| +| Command arguments | | +| release bundle name | The name of the release bundle. | +| release bundle version | The release bundle version. | +| pattern | Specifies the source path in Artifactory, from which the artifacts should be bundled, in the following format: \/\. You can use wildcards to specify multiple artifacts. This argument should not be sent along with the _--spec_ option. | #### Example 1 @@ -180,19 +180,19 @@ This command GPG signs an existing Release Bundle on JFrog Distribution. #### Commands Params -| | | -|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Command-name | release-bundle-sign | -| Abbreviation | rbs | -| Command options | | -| --server-id |

[Optional]

Artifactory server ID configured using the config command.

| -| --passphrase |

[Optional]

The passphrase for the signing key.

| -| --repo |

[Optional]

A repository name at source Artifactory to store release bundle artifacts in. If not provided, Artifactory will use the default one.

| -| --insecure-tls |

[Default: false]

Set to true to skip TLS certificates verification.

| -| --detailed-summary |

[Default: false]

Set to true to return the SHA256 value of the release bundle manifest.

| -| Command arguments | | -| release bundle name | The name of the release bundle. | -| release bundle version | The release bundle version. | +| | | +|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| +| Command-name | release-bundle-sign | +| Abbreviation | rbs | +| Command options | | +| --server-id |

[Optional]
Artifactory server ID configured using the config command.

| +| --passphrase |

[Optional]
The passphrase for the signing key.

| +| --repo |

[Optional]
A repository name at source Artifactory to store release bundle artifacts in. If not provided, Artifactory will use the default one.

| +| --insecure-tls |

[Optional]
Set to true to skip TLS certificates verification.

| +| --detailed-summary |

[Optional]
Set to true to return the SHA256 value of the release bundle manifest.

| +| Command arguments | | +| release bundle name | The name of the release bundle. | +| release bundle version | The release bundle version. | #### Example @@ -216,24 +216,24 @@ This command distributes a release bundle to the Edge Nodes. #### Commands Params -| | | -|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Command-name | release-bundle-distribute | -| Abbreviation | rbd | -| Command options | | -| --server-id |

[Optional]

Artifactory server ID configured using the config command.

| -| --sync |

[Default: false]

Set to true to enable sync distribution (the command execution will end when the distribution process ends).

| -| --max-wait-minutes |

[Default: 60]

Max minutes to wait for sync distribution.

| -| --create-repo |

[Default: false]

Set to true to create the repository on the edge if it does not exist.

| -| --dry-run |

[Default: false]

Set to true to disable communication with JFrog Distribution.

| -| --dist-rules |

[Optional]

Path to a file, which includes the Distribution Rules in a JSON format.

Distribution Rules JSON structure

{
"distribution_rules": [
{
"site_name": "DC-1",
"city_name": "New-York",
"country_codes": ["1"]
},
{
"site_name": "DC-2",
"city_name": "Tel-Aviv",
"country_codes": ["972"]
}
]
}

The Distribution Rules format also supports wildcards. For example:

{
"distribution_rules": [
{
"site_name": "",
"city_name": "",
"country_codes": ["*"]
}
]
}

| -| --site |

[Default: *]

Wildcard filter for site name.

| -| --city |

[Default: *]

Wildcard filter for site city name.

| -| --country-codes |

[Default: *]

Semicolon-separated list of wildcard filters for site country codes.

| -| --insecure-tls |

[Default: false]

Set to true to skip TLS certificates verification.

| -| Command arguments | | -| release bundle name | The name of the release bundle. | -| release bundle version | The release bundle version. | +| | | +|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Command-name | release-bundle-distribute | +| Abbreviation | rbd | +| Command options | | +| --server-id |

[Optional]
Artifactory server ID configured using the config command.

| +| --sync |

[Optional]
Set to true to enable sync distribution (the command execution will end when the distribution process ends).

| +| --max-wait-minutes |

[Default: 60]
Max minutes to wait for sync distribution.

| +| --create-repo |

[Optional]
Set to true to create the repository on the edge if it does not exist.

| +| --dry-run |

[Optional]
Set to true to disable communication with JFrog Distribution.

| +| --dist-rules |

[Optional]
Path to a file, which includes the Distribution Rules in a JSON format.

Distribution Rules JSON structure

{
"distribution_rules": [
{
"site_name": "DC-1",
"city_name": "New-York",
"country_codes": ["1"]
},
{
"site_name": "DC-2",
"city_name": "Tel-Aviv",
"country_codes": ["972"]
}
]
}

The Distribution Rules format also supports wildcards. For example:

{
"distribution_rules": [
{
"site_name": "",
"city_name": "",
"country_codes": ["*"]
}
]
}

| +| --site |

[Default: *]
Wildcard filter for site name.

| +| --city |

[Default: *]
Wildcard filter for site city name.

| +| --country-codes |

[Default: *]
Semicolon-separated list of wildcard filters for site country codes.

| +| --insecure-tls |

[Optional]
Set to true to skip TLS certificates verification.

| +| Command arguments | | +| release bundle name | The name of the release bundle. | +| release bundle version | The release bundle version. | #### Example 1 @@ -258,25 +258,25 @@ This command deletes a Release Bundle from the Edge Nodes and optionally from Di #### Commands Params -| | | -|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Command-name | release-bundle-delete | -| Abbreviation | rbdel | -| Command options | | -| --server-id |

[Optional]

Artifactory server ID configured using the config command.

| -| --sync |

[Default: false]

Set to true to enable sync deletion (the command execution will end when the deletion process ends).

| -| --max-wait-minutes |

[Default: 60]

Max minutes to wait for sync deletion.

| -| --dry-run |

[Default: false]

Set to true to disable communication with JFrog Distribution.

| -| --dist-rules |

[Optional]

Path to a file, which includes the distribution rules in a JSON format.

| -| --site |

[Default: *]

Wildcard filter for site name.

| -| --city |

[Default: *]

Wildcard filter for site city name.

| -| --country-codes |

[Default: *]

Semicolon-separated list of wildcard filters for site country codes.

| -| --delete-from-dist |

[Default: false]

Set to true to delete release bundle version in JFrog Distribution itself after deletion is complete in the specified Edge nodes.

| -| --quiet |

[Default: false]

Set to true to skip the delete confirmation message.

| -| --insecure-tls |

[Default: false]

Set to true to skip TLS certificates verification.

| -| Command arguments | | -| release bundle name | The name of the release bundle. | -| release bundle version | The release bundle version. | +| | | +|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------| +| Command-name | release-bundle-delete | +| Abbreviation | rbdel | +| Command options | | +| --server-id |

[Optional]
Artifactory server ID configured using the config command.

| +| --sync |

[Optional]
Set to true to enable sync deletion (the command execution will end when the deletion process ends).

| +| --max-wait-minutes |

[Default: 60]
Max minutes to wait for sync deletion.

| +| --dry-run |

[Optional]
Set to true to disable communication with JFrog Distribution.

| +| --dist-rules |

[Optional]
Path to a file, which includes the distribution rules in a JSON format.

| +| --site |

[Default: *]
Wildcard filter for site name.

| +| --city |

[Default: *]
Wildcard filter for site city name.

| +| --country-codes |

[Default: *]
Semicolon-separated list of wildcard filters for site country codes.

| +| --delete-from-dist |

[Optional]
Set to true to delete release bundle version in JFrog Distribution itself after deletion is complete in the specified Edge nodes.

| +| --quiet |

[Optional]
Set to true to skip the delete confirmation message.

| +| --insecure-tls |

[Optional]
Set to true to skip TLS certificates verification.

| +| Command arguments | | +| release bundle name | The name of the release bundle. | +| release bundle version | The release bundle version. | #### Example 1 diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-pipelines.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-pipelines.md index 69f3833..527b9c3 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-pipelines.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-pipelines.md @@ -30,13 +30,13 @@ The following sections describe the commands available in the JFrog CLI for use ##### Commands Params -| | | -|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------| -| Command name | pl version | -| Abbreviation | v | -| Command arguments | The command accepts no arguments. | -| Command options | | -| --server-id |

[Optional]

Specify Pipelines server for which the version is to be fetched. If not specified, the default configured server is used.

| +| | | +|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------| +| Command name | pl version | +| Abbreviation | v | +| Command arguments | The command accepts no arguments. | +| Command options | | +| --server-id |

[Optional]
Specify Pipelines server for which the version is to be fetched. If not specified, the default configured server is used.

| ##### Example @@ -51,18 +51,18 @@ Get the status of the run for the specified pipeline ##### Commands Params -| | | -|-------------------|--------------------------------------------------------------------------------------------------------------------------------| -| Command name | pl status | -| Abbreviation | s | -| Command arguments | The command accepts no arguments. | -| | | -| Command options | | -| --pipeline-name |

[Optional]

Name of the pipeline.

| -| --branch |

[Optional]

Name of the multi branch.

| -| --monitor |

[Optional]

Continuous monitoring until pipeline reaches end state.

Default time is 1 hour and 30 minutes.

| -| --server-id |

[Optional]

Name of the server.

| -| --single-branch |

[Optional]

To be used when using a single branch.

| +| | | +|-------------------|----------------------------------------------------------------------------------------------------------------------------| +| Command name | pl status | +| Abbreviation | s | +| Command arguments | The command accepts no arguments. | +| | | +| Command options | | +| --pipeline-name |

[Optional]
Name of the pipeline.

| +| --branch |

[Optional]
Name of the multi branch.

| +| --monitor |

[Optional]
Continuous monitoring until pipeline reaches end state.

Default time is 1 hour and 30 minutes.

| +| --server-id |

[Optional]
Name of the server.

| +| --single-branch |

[Optional]
To be used when using a single branch.

| ##### Example 1 @@ -85,16 +85,16 @@ Trigger a pipeline run. ##### Commands Params -| | | -|-------------------|--------------------------------------------------------------------------------------------------------------------------| -| Command name | pl trigger | -| Abbreviation | t | -| Command options | | -| --server-id |

[Optional]

Name of the server.

| -| --single-branch |

[Optional]

To be used when using a single branch. When used, branch_name argument is ignored.

| -| Command arguments | | -| pipeline\_name | Name of the pipeline to be triggered. | -| branch\_name | Name of the multi branch. | +| | | +|-------------------|----------------------------------------------------------------------------------------------------------------------| +| Command name | pl trigger | +| Abbreviation | t | +| Command options | | +| --server-id |

[Optional]
Name of the server.

| +| --single-branch |

[Optional]
To be used when using a single branch. When used, branch_name argument is ignored.

| +| Command arguments | | +| pipeline\_name | Name of the pipeline to be triggered. | +| branch\_name | Name of the multi branch. | ##### Example 1 @@ -116,14 +116,14 @@ jf pl trigger myPipeline main/jobs --server-id repo21 ##### Commands Params -| | | -|-----------------|-------------------------------------------------------------------------------------------| -| Command name | pl sync | -| Abbreviation | sy | -| Command options | | -| --server-id |

[Optional]

Name of the server.

| -| --repository |

[Optional]

Full name of the repository where the pipeline source is stored.

| -| --branch |

[Optional]

Name of branch that has the pipeline source.

| +| | | +|-----------------|---------------------------------------------------------------------------------------| +| Command name | pl sync | +| Abbreviation | sy | +| Command options | | +| --server-id |

[Optional]
Name of the server.

| +| --repository |

[Optional]
Full name of the repository where the pipeline source is stored.

| +| --branch |

[Optional]
Name of branch that has the pipeline source.

| ##### Example @@ -141,7 +141,7 @@ jf pl sync --repository jfrog/artifactory --branch main/jobs --server-id repo21 | Command name | pl sync-status | | Abbreviation | ss | | Command options | | -| --server-id |

[Optional]

Name of the server.

| +| --server-id |

[Optional]
Name of the server.

| | Command arguments | | | full\_repo\_name | Full name of the repository where the pipeline source is stored. | | branch\_name | Name of the branch. | diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-security/download-updates-for-xrays-database.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-security/download-updates-for-xrays-database.md index 0f3c981..8784fdf 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-security/download-updates-for-xrays-database.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-security/download-updates-for-xrays-database.md @@ -2,4 +2,4 @@ The offline-update command downloads updates to Xray's vulnerabilities database. The Xray UI allows building the command structure for you. -
Command namexr offline-update
Abbreviationxr ou
Command options
--license-id[Mandatory]

Xray license ID.
--from[Optional]

From update date in YYYY-MM-DD format.
--to[Optional]

To update date in YYYY-MM-DD format.
--version[Optional]

Xray API version.
--target[Default: ./]

Path for downloaded update files.
--dbsyncv3[Default: false]

Set to true to use Xray DBSync V3.
--periodic[Default: false]

Set to true to get the Xray DBSync V3 Periodic Package (Use with dbsyncv3 flag).
Command argumentsThe command accepts no arguments.
+
Command namexr offline-update
Abbreviationxr ou
Command options
--license-id[Mandatory]
Xray license ID.
--from[Optional]
From update date in YYYY-MM-DD format.
--to[Optional]
To update date in YYYY-MM-DD format.
--version[Optional]
Xray API version.
--target[Default: ./]
Path for downloaded update files.
--dbsyncv3[Optional]
Set to true to use Xray DBSync V3.
--periodic[Optional]
Set to true to get the Xray DBSync V3 Periodic Package (Use with dbsyncv3 flag).
Command argumentsThe command accepts no arguments.
diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-published-builds.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-published-builds.md index 2633df2..58ca727 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-published-builds.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-published-builds.md @@ -11,12 +11,12 @@ JFrog CLI is integrated with JFrog Xray and JFrog Artifactory, allowing you to h | Command name | build-scan | | Abbreviation | bs | | Command options | | -| --server-id |

[Optional]

Server ID configured by the jf c add command. If not specified, the default configured server is used.

| -| --vuln |

[Optional]

Set if you'd like to receive all vulnerabilities, regardless of the policy configured in Xray.

| -| --fail |

[Default: true]

When set, the command returns exit code 3 if a 'Fail Build' rule is matched by Xray.
Set to false if you do not wish the command to return exit code 3 in such case, and an exit code 0 will be returned.

| -| --format |

[Default: table]

Defines the output format of the command. The accepted values are: table and json.

| -| --project |

[Optional]

JFrog project key

| -| --rescan |

[Default: false]

Set to true when scanning an already successfully scanned build, for example after adding an ignore rule.

| +| --server-id |

[Optional]
Server ID configured by the jf c add command. If not specified, the default configured server is used.

| +| --vuln |

[Optional]
Set if you'd like to receive all vulnerabilities, regardless of the policy configured in Xray.

| +| --fail |

[Default: true]
When set, the command returns exit code 3 if a 'Fail Build' rule is matched by Xray.
Set to false if you do not wish the command to return exit code 3 in such case, and an exit code 0 will be returned.

| +| --format |

[Default: table]
Defines the output format of the command. The accepted values are: table and json.

| +| --project |

[Optional]
JFrog project key

| +| --rescan |

[Optional]
Set to true when scanning an already successfully scanned build, for example after adding an ignore rule.

| | Command arguments | The command accepts two arguments. | | Build name | Build name to be scanned. | | Build number | Build number to be scanned. | diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-your-binaries.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-your-binaries.md index a54b1c1..0c160d8 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-your-binaries.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-your-binaries.md @@ -24,13 +24,13 @@ This _**jf scan**_ command scans files on the local file system with Xray. | **Command name** | scan | | **Abbreviation** | s | | **Command options** | | -| --server-id |

[Optional]

Server ID configured using the jf c add command. If not specified, the default configured server is used.

| -| --spec |

[Optional]

Path to a file specifying the files to scan. If the pattern argument is provided to the command, this option should not be provided.

| -| --project |

[Optional]

JFrog project key, to enable Xray to determine security violations accordingly. The command accepts this option only if the --repo-path and --watches options are not provided. If none of the three options are provided, the command will show all known vulnerabilities.

| -| --repo-path |

[Optional]

Artifactory repository path in the form of <repository>/<path in the repository>, to enable Xray to determine violations accordingly. The command accepts this option only if the --project and --watches options are not provided. If none of the three options are provided, the command will show all known vulnerabilities.

| -| --watches |

[Optional]

A comma-separated list of Xray watches, to enable Xray to determine violations accordingly. The command accepts this option only if the --project and --repo-path options are not provided. If none of the three options are provided, the command will show all known vulnerabilities.

| -| --licenses |

[Default: false]

Set if you also require the list of licenses to be displayed.

| -| --format=json |

[Optional]

Produces a JSON file containing the scan results.

| +| --server-id |

[Optional]
Server ID configured using the jf c add command. If not specified, the default configured server is used.

| +| --spec |

[Optional]
Path to a file specifying the files to scan. If the pattern argument is provided to the command, this option should not be provided.

| +| --project |

[Optional]
JFrog project key, to enable Xray to determine security violations accordingly. The command accepts this option only if the --repo-path and --watches options are not provided. If none of the three options are provided, the command will show all known vulnerabilities.

| +| --repo-path |

[Optional]
Artifactory repository path in the form of <repository>/<path in the repository>, to enable Xray to determine violations accordingly. The command accepts this option only if the --project and --watches options are not provided. If none of the three options are provided, the command will show all known vulnerabilities.

| +| --watches |

[Optional]
A comma-separated list of Xray watches, to enable Xray to determine violations accordingly. The command accepts this option only if the --project and --repo-path options are not provided. If none of the three options are provided, the command will show all known vulnerabilities.

| +| --licenses |

[Optional]
Set if you also require the list of licenses to be displayed.

| +| --format=json |

[Optional]
Produces a JSON file containing the scan results.

| | **Command arguments** | | | **Pattern** | Specifies the local file system path to artifacts to be scanned. You can specify multiple files by using wildcards. | @@ -104,12 +104,12 @@ This j\_**f docker scan**\_ command scans docker containers located on the local | **Command name** | docker scan | | **Abbreviation** | | | **Command options** | | -| --server-id |

[Optional]

Server ID configured using the jf c add command. If not specified, the default configured server is used.

| -| --project |

[Optional]

JFrog project key, to enable Xray to determine security violations accordingly. The command accepts this option only if the --repo-path and --watches options are not provided. If none of the three options are provided, the command will show all known vulnerabilities.

| -| --repo-path |

[Optional]

Artifactory repository path in the form of <repository>/<path in the repository>, to enable Xray to determine violations accordingly. The command accepts this option only if the --project and --watches options are not provided. If none of the three options are provided, the command will show all known vulnerabilities.

| -| --watches |

[Optional]

A comma separated list of Xray watches, to enable Xray to determine violations accordingly. The command accepts this option only if the --repo-path and --repo-path options are not provided. If none of the three options are provided, the command will show all known vulnerabilities.

| -| --licenses |

[Default: false]

Set if you also require the list of licenses to be displayed.

| -| --format=json |

[Optional]

Produces a JSON file containing the scan results.

| +| --server-id |

[Optional]
Server ID configured using the jf c add command. If not specified, the default configured server is used.

| +| --project |

[Optional]
JFrog project key, to enable Xray to determine security violations accordingly. The command accepts this option only if the --repo-path and --watches options are not provided. If none of the three options are provided, the command will show all known vulnerabilities.

| +| --repo-path |

[Optional]
Artifactory repository path in the form of <repository>/<path in the repository>, to enable Xray to determine violations accordingly. The command accepts this option only if the --project and --watches options are not provided. If none of the three options are provided, the command will show all known vulnerabilities.

| +| --watches |

[Optional]
A comma separated list of Xray watches, to enable Xray to determine violations accordingly. The command accepts this option only if the --repo-path and --repo-path options are not provided. If none of the three options are provided, the command will show all known vulnerabilities.

| +| --licenses |

[Optional]
Set if you also require the list of licenses to be displayed.

| +| --format=json |

[Optional]
Produces a JSON file containing the scan results.

| | **Command arguments** | | | **Pattern** | Specifies the local file system path to artifacts to be scanned. You can specify multiple files by using wildcards. | diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-your-source-code.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-your-source-code.md index 806590a..1a5434c 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-your-source-code.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-your-source-code.md @@ -40,30 +40,30 @@ This command also supports the following Advanced Scans with the **Advanced Secu | **Command name** | audit | | **Abbreviation** | aud | | **Command options** | | -| --server-id |

[Optional]

Server ID configured using the jf c add command. If not specified, the default configured server is used.

| -| --project |

[Optional]

JFrog project key, to enable Xray to determine security violations accordingly. The command accepts this option only if the --repo-path and --watches options are not provided. If none of the three options are provided, the command will show all known vulnerabilities

| -| --repo-path |

[Optional]

Artifactory repository path in the form of <repository>/<path in the repository>, to enable Xray to determine violations accordingly. The command accepts this option only if the --project and --watches options are not provided. If none of the three options are provided, the command will show all known vulnerabilities

| -| --watches |

[Optional]

A comma-separated list of Xray watches, to enable Xray to determine violations accordingly. The command accepts this option only if the --repo-path and --repo-path options are not provided. If none of the three options are provided, the command will show all known vulnerabilities

| -| --licenses |

[Default: false]

Set if you'd also like the list of licenses to be displayed.

| -| --format |

[Default: table]

Defines the output format of the command. Acceptable values are: table and json.

| -| --fail |

[Default: true]

Set to false if you do not wish the command to return exit code 3, even if the 'Fail Build' rule is matched by Xray.

| -| --use-wrapper |

[Default: false] [Gradle]

Set to true if you'd like to use the Gradle wrapper.

| -| --dep-type |

[Default: all] [npm]

Defines npm dependencies type. Possible values are: all, devOnly and prodOnly

| -| --exclude-test-deps |

[Default: false] [Gradle]

Set to true if you'd like to exclude Gradle test dependencies from Xray scanning.

| -| --requirements-file |

[Optional] [Pip]

Defines pip requirements file name. For example: 'requirements.txt'

| -| --working-dirs |

[Optional]

A comma-separated list of relative working directories, to determine the audit targets locations.

If flag isn't provided, a recursive scan is triggered from the root directory of the project. | -| --exclusions |

[Default: *.git*;*node_modules*;*target*;*venv*;*test*]

List of exclusions separated by semicolons, utilized to skip sub-projects from undergoing an audit. These exclusions may incorporate the * and ? wildcards.

| -| --fixable-only |

[Optional]

Set to true if you wish to display issues that have a fix version only.

| -| --min-severity |

[Optional]

Set the minimum severity of issues to display. The following values are accepted: Low, Medium, High or Critical

| -| --go |

[Default: false]

Set to true to request audit for a Go project.

| -| --gradle |

[Default: false]

Set to true to request audit for a Gradle project.

| -| --mvn |

[Default: false]

Set to true to request audit for a Maven project.

| -| --npm |

[Default: false]

Set to true to request audit for a npm project.

| -| --pnpm |

[Default: false]

Set to true to request audit for a pnpm project.

| -| --nuget |

[Default: false]

Set to true to request audit for a .Net project.

| -| --pip |

[Default: false]

Set to true to request audit for a Pip project.

| -| --pipenv |

[Default: false]

Set to true to request audit for a Pipenv project.

| -| --yarn |

[Default: false]

Set to true to request audit for a Yarn project.

| +| --server-id |

[Optional]
Server ID configured using the jf c add command. If not specified, the default configured server is used.

| +| --project |

[Optional]
JFrog project key, to enable Xray to determine security violations accordingly. The command accepts this option only if the --repo-path and --watches options are not provided. If none of the three options are provided, the command will show all known vulnerabilities

| +| --repo-path |

[Optional]
Artifactory repository path in the form of <repository>/<path in the repository>, to enable Xray to determine violations accordingly. The command accepts this option only if the --project and --watches options are not provided. If none of the three options are provided, the command will show all known vulnerabilities

| +| --watches |

[Optional]
A comma-separated list of Xray watches, to enable Xray to determine violations accordingly. The command accepts this option only if the --repo-path and --repo-path options are not provided. If none of the three options are provided, the command will show all known vulnerabilities

| +| --licenses |

[Optional]
Set if you'd also like the list of licenses to be displayed.

| +| --format |

[Default: table]
Defines the output format of the command. Acceptable values are: table and json.

| +| --fail |

[Default: true]
Set to false if you do not wish the command to return exit code 3, even if the 'Fail Build' rule is matched by Xray.

| +| --use-wrapper |

[Default: false] [Gradle]
Set to true if you'd like to use the Gradle wrapper.

| +| --dep-type |

[Default: all] [npm]
Defines npm dependencies type. Possible values are: all, devOnly and prodOnly

| +| --exclude-test-deps |

[Default: false] [Gradle]
Set to true if you'd like to exclude Gradle test dependencies from Xray scanning.

| +| --requirements-file |

[Optional] [Pip]
Defines pip requirements file name. For example: 'requirements.txt'

| +| --working-dirs |

[Optional]
A comma-separated list of relative working directories, to determine the audit targets locations.

If flag isn't provided, a recursive scan is triggered from the root directory of the project. | +| --exclusions |

[Default: *.git*;*node_modules*;*target*;*venv*;*test*]
List of exclusions separated by semicolons, utilized to skip sub-projects from undergoing an audit. These exclusions may incorporate the * and ? wildcards.

| +| --fixable-only |

[Optional]
Set to true if you wish to display issues that have a fix version only.

| +| --min-severity |

[Optional]
Set the minimum severity of issues to display. The following values are accepted: Low, Medium, High or Critical

| +| --go |

[Optional]
Set to true to request audit for a Go project.

| +| --gradle |

[Optional]
Set to true to request audit for a Gradle project.

| +| --mvn |

[Optional]
Set to true to request audit for a Maven project.

| +| --npm |

[Optional]
Set to true to request audit for a npm project.

| +| --pnpm |

[Optional]
Set to true to request audit for a pnpm project.

| +| --nuget |

[Optional]
Set to true to request audit for a .Net project.

| +| --pip |

[Optional]
Set to true to request audit for a Pip project.

| +| --pipenv |

[Optional]
Set to true to request audit for a Pipenv project.

| +| --yarn |

[Optional]
Set to true to request audit for a Yarn project.

| | **Command arguments** | The command accepts no arguments | #### **Output Example** @@ -135,7 +135,7 @@ Execute a cUrl command, using the configured Xray details. The command expects t | Command name | xr curl | | Abbreviation | xr cl | | Command options | | -| --server-id |

[Optional]

Server ID configured using the jf c add command. If not specified, the default configured server is used.

| +| --server-id |

[Optional]
Server ID configured using the jf c add command. 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:

1. The full Xray URL should not be passed. Instead, the REST endpoint URI should be sent.
2. The login credentials should not be passed. Instead, the --server-id should be used.

| diff --git a/jfrog-applications/jfrog-cli/get-started/configurations/jfrog-platform-configuration.md b/jfrog-applications/jfrog-cli/get-started/configurations/jfrog-platform-configuration.md index e1286f2..9222c55 100644 --- a/jfrog-applications/jfrog-cli/get-started/configurations/jfrog-platform-configuration.md +++ b/jfrog-applications/jfrog-cli/get-started/configurations/jfrog-platform-configuration.md @@ -64,7 +64,7 @@ The **config add** and **config edit** commands are used to add and edit JFrog P | --client-cert-key-path |

[Optional]

Private key file for the client certificate in PEM format.

| | --client-cert-path |

[Optional]

Client certificate file in PEM format.

| | --dist-url |

[Optional]

Distribution URL.

| -| --enc-password |

[Default: true]

If true, the configured password will be encrypted using Artifactory'sencryption API before being stored. If false, the configured password will not be encrypted.

| +| --enc-password |

[Default: true]
If true, the configured password will be encrypted using Artifactory'sencryption API before being stored. If false, the configured password will not be encrypted.

| | --insecure-tls |

[Default: false]

Set to true to skip TLS certificates verification, while encrypting the Artifactory password during the config process.

| | --interactive |

[Default: true, unless $CI is true]

Set to false if you do not want the config command to be interactive.

| | --mission-control-url |

[Optional]

Mission Control URL.

| @@ -74,7 +74,7 @@ The **config add** and **config edit** commands are used to add and edit JFrog P | --url |

[Optional]

JFrog platform URL.

| | --user |

[Optional]

JFrog Platform username.

| | --xray-url | \[Optional] Xray URL. | -| --overwrite |

[Available for config add only]

[Default: false]

Overwrites the instance configuration if an instance with the same ID already exists.

| +| --overwrite |

[Available for config add only]
[Optional]
Overwrites the instance configuration if an instance with the same ID already exists.

| | Command arguments | | | server ID | A unique ID for the server configuration. | From aa264572ea2596e2d51854d70169fdc0c6f0834a Mon Sep 17 00:00:00 2001 From: Michael Sverdlov Date: Sun, 14 Apr 2024 20:00:42 +0300 Subject: [PATCH 4/9] fix docs --- .../build-integration.md | 20 ++--- .../environment-variables.md | 4 +- .../generic-files.md | 84 +++++++++---------- .../package-managers-integration.md | 28 +++---- .../release-lifecycle-management.md | 14 ++-- .../verifying-artifactory-accessibility.md | 2 +- .../jfrog-cli/cli-for-jfrog-distribution.md | 26 +++--- .../download-updates-for-xrays-database.md | 2 +- .../scan-published-builds.md | 2 +- .../scan-your-binaries.md | 4 +- .../scan-your-source-code.md | 20 ++--- .../jfrog-platform-configuration.md | 2 +- 12 files changed, 104 insertions(+), 104 deletions(-) diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/build-integration.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/build-integration.md index 3bcf1cb..0f76c4d 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/build-integration.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/build-integration.md @@ -143,13 +143,13 @@ By default, the command collects the files from the local file system. If you'd | 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 |

[Optional]
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.

| +| --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]
List 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 |

[Optional]
Set to true to only get a summery of the dependencies that will be added to the build info.

| +| --dry-run |

[Default: false]
Set to true to only get a summery of the dependencies that will be added to the build info.

| | --module |

[Optional]
Optional module name in the build-info for adding the dependency.

| | --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 three arguments. | @@ -203,8 +203,8 @@ jf rt bp my-build-name 18 | --build-url |

[Optional]
Can be used for setting the CI server build URL in the build-info.

| | --env-include |

[Default: *]
List 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*]
List of case insensitive patterns in the form of "value1;value2;..." environment variables match those patterns will be excluded.

| -| --dry-run |

[Optional]
Set to true to disable communication with Artifactory.

| -| --insecure-tls |

[Optional]
Set to true to skip TLS certificates verification.

| +| --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. | @@ -308,11 +308,11 @@ This command is used to [promote build](https://jfrog.com/knowledge-base/how-doe | --status |

[Optional]
Build promotion status.

| | --comment |

[Optional]
Build promotion comment.

| | --source-repo |

[Optional]
Build promotion source repository.

| -| --include-dependencies |

[Optional]
If set to true, the build dependencies are also promoted.

| -| --copy |

[Optional]
If set true, the build artifacts and dependencies are copied to the target repository, otherwise they are moved.

| +| --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]
List of properties in the form of "key1=value1;key2=value2,...". to attach to the build artifacts.

| -| --dry-run |

[Optional]
If true, promotion is only simulated. The build is not promoted.

| -| --insecure-tls |

[Optional]
Set to true to skip TLS certificates verification.

| +| --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. | @@ -369,8 +369,8 @@ The following table lists the command arguments and flags: | --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]
List of build numbers in the form of "value1,value2,...", that should not be removed from Artifactory.

| -| --delete-artifacts |

[Optional]
If set to true, automatically removes build artifacts stored in Artifactory.

| -| --async |

[Optional]
If set to true, build discard will run asynchronously and will not wait for response.

| +| --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. | diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/environment-variables.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/environment-variables.md index 661458d..9fce278 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/environment-variables.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/environment-variables.md @@ -16,8 +16,8 @@ Some of the Artifactory commands make use of the following environment variable: | **JFROG\_CLI\_BUILD\_PROJECT** | JFrog project key to be used by commands that expect build name and build number. Determines the project of the published build. | | **JFROG\_CLI\_BUILD\_URL** | Sets the CI server build URL in the build-info. The "jf rt build-publish" command uses the value of this environment variable unless the --build-url command option is sent. | | **JFROG\_CLI\_ENV\_EXCLUDE** |

[Default: *password*;*secret*;*key*;*token*]
List of case insensitive patterns in the form of "value1;value2;...". Environment variables match those patterns will be excluded. This environment variable is used by the "jf rt build-publish" command, in case the --env-exclude command option is not sent.

| -| **JFROG\_CLI\_TRANSITIVE\_DOWNLOAD\_EXPERIMENTAL** |

[Optional]
Used by the "jf rt download" command. Set to true to download artifacts also from remote repositories. This feature is experimental and available on Artifactory version 7.17.0 or higher.

| -| **JFROG\_CLI\_UPLOAD\_EMPTY\_ARCHIVE** |

[Optional]
Used by the "jf rt upload" command. Set to true if you'd like to upload an empty archive when '--archive' is set but all files were excluded by exclusions pattern.

| +| **JFROG\_CLI\_TRANSITIVE\_DOWNLOAD\_EXPERIMENTAL** |

[Default: false]
Used by the "jf rt download" command. Set to true to download artifacts also from remote repositories. This feature is experimental and available on Artifactory version 7.17.0 or higher.

| +| **JFROG\_CLI\_UPLOAD\_EMPTY\_ARCHIVE** |

[Default: false]
Used by the "jf rt upload" command. Set to true if you'd like to upload an empty archive when '--archive' is set but all files were excluded by exclusions pattern.

| *** diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/generic-files.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/generic-files.md index 2281bbb..112259a 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/generic-files.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/generic-files.md @@ -29,23 +29,23 @@ This command is used to upload files to Artifactory. | --module |

[Optional]
Optional module name for the build-info.

| | --target-props |

[Optional]
A list of Artifactory properties specified 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".

| | --deb |

[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 |

[Optional]
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.

If Using Placeholders are used, the value of this option is ignored.

Note

JFrog CLI v1

In JFrog CLI v1, the default value of the --flat option is true.

| +| --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.

If Using Placeholders are used, the value of this option is ignored.

Note

JFrog CLI v1

In 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 |

[Optional]
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 |

[Optional]
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.

| +| --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 |

[Optional]
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 |

[Optional]
If true, the command will preserve the soft links structure in Artifactory. The symlink file representation will contain the symbolic link and checksum properties.

| -| --explode |

[Optional]
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 |

[Optional]
If true, the source path applies to bottom-chain directories and not only to files. Bottom-chain directories are either empty or do not include other directories that match the source path.

| +| --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. The symlink file 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. Bottom-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 --regexp and --ant options. Please read the --regexp and --ant options 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 |

[Optional]
If true, the delete confirmation message is skipped.

| -| --fail-no-op |

[Optional]
Set to true if you'd like the command to return exit code 2 in case of no files are affected.

| +| --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 |

[Optional]
Set to true to include a list of the affected files as part of the command output summary.

| -| --insecure-tls |

[Optional]
Set to true to skip TLS certificates verification.

| +| --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.

| | --min-split |

[Default: 200]
The minimum file size in MiB required to attempt a multi-part upload. This option, as well as the functionality of multi-part upload, requires Artifactory with S3 storage.

| | --split-count |

[Default: 5]
The maximum number of parts that can be concurrently uploaded per file during a multi-part upload. Set to 0 to disable multi-part upload. This option, as well as the functionality of multi-part upload, requires Artifactory with S3 storage.

| @@ -140,29 +140,29 @@ This command is used to download files from Artifactory. | --exclude-props |

[Optional]
A list of Artifactory properties specified as "key=value" pairs separated by a semi-colon (for example, "key1=value1;key2=value2;key3=value3"). Only artifacts without all of 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 |

[Optional]
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.

If Using Placeholders are 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.

| +| --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.

If Using Placeholders are 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 --min-split in size). To download each file in a single thread, set to 0.

| | --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 --split-count segments. Any files smaller than the specified number will be downloaded in a single thread. If set to -1, files are not split.

| -| --dry-run |

[Optional]
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 |

[Optional]
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.

| -| --bypass-archive-inspection |

[Optional]
Set to true to bypass the archive security inspection before it is unarchived. Used with the 'explode' option.

| -| --validate-symlinks |

[Optional]
If true, the command will validate that symlinks are pointing to existing and unchanged files, by comparing their sha1. Applicable to files and not directories.

| -| --include-dirs |

[Optional]
If true, the source path applies to bottom-chain directories and not only to files. Bottom-chain directories are either empty or do not include other directories that match the source path.

| +| --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.

| +| --bypass-archive-inspection |

[Default: false]
Set to true to bypass the archive security inspection before it is unarchived. Used with the 'explode' option.

| +| --validate-symlinks |

[Default: false]
If true, the command will validate that symlinks are 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. Bottom-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 |

[Optional]
If true, the delete confirmation message is skipped.

| +| --quiet |

[Default: false]
If true, the delete confirmation message is skipped.

| | --sort-by |

[Optional]
A list of semicolon-separated fields to sort by. The fields must be part of the 'items' AQL domain. For more information read the AQL 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 |

[Optional]
Set to true if you'd like the command to return exit code 2 in case of no files are affected.

| +| --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 |

[Optional]
Set to true to include a list of the affected files as part of the command output summary.

| -| --insecure-tls |

[Optional]
Set to true to skip TLS certificates verification.

| +| --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.

| @@ -224,18 +224,18 @@ This command is used to copy files in Artifactory | --exclude-props |

[Optional]
A list of Artifactory properties specified as "key=value" pairs separated by a semi-colon (for example, "key1=value1;key2=value2;key3=value3"). Only artifacts without all of 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 |

[Optional]
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.

| +| --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 |

[Optional]
If true, the command only indicates which artifacts would have been copied.

If false, the command is fully executed and copies artifacts as specified.

| +| --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]
A list of semicolon-separated fields to sort by. The fields must be part of the 'items' AQL domain. For more information read the AQL 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 |

[Optional]
Set to true if you'd like the command to return exit code 2 in case of no files are affected.

| +| --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 |

[Optional]
Set to true to skip TLS certificates verification.

| +| --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.

| @@ -289,18 +289,18 @@ This command is used to move files in Artifactory | --exclude-props |

[Optional]
A list of Artifactory properties specified as "key=value" pairs separated by a semi-colon (for example, "key1=value1;key2=value2;key3=value3"). Only artifacts without all of 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 |

[Optional]
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.

| +| --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 |

[Optional]
If true, the command only indicates which artifacts would have been moved.

If false, the command is fully executed and downloads artifacts as specified.

| +| --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]
A list of semicolon-separated fields to sort by. The fields must be part of the 'items' AQL domain. For more information read the AQL 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 |

[Optional]
Set to true if you'd like the command to return exit code 2 in case of no files are affected.

| +| --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 |

[Optional]
Set to true to skip TLS certificates verification.

| +| --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.

| @@ -354,17 +354,17 @@ This command is used to delete files in Artifactory | --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 |

[Optional]
If true, the delete confirmation message is skipped.

| -| --dry-run |

[Optional]
If true, the command only indicates which artifacts would have been deleted.

If false, the command is fully executed and deletes artifacts as specified.

| +| --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]
A list of semicolon-separated fields to sort by. The fields must be part of the 'items' AQL domain. For more information read the AQL 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 |

[Optional]
Set to true if you'd like the command to return exit code 2 in case of no files are affected.

| +| --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 |

[Optional]
Set to true to skip TLS certificates verification.

| +| --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

| @@ -408,7 +408,7 @@ This command is used to search and display files in Artifactory. | --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 to Using File Specs.

| | --count |

[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

| +| --include-dirs |

[Default: false]
Set to true if you'd like to also apply the source path pattern for directories and not only for files

| | --spec-vars |

[Optional]
List 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 Artifactory properties specified as "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 Artifactory properties specified as "key=value" pairs separated by a semi-colon (for example, "key1=value1;key2=value2;key3=value3"). Only artifacts without all of the specified properties names and values will be returned.

| @@ -421,9 +421,9 @@ This command is used to search and display files in Artifactory. | --transitive |

[Optional]
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 |

[Optional]
Set to true if you'd like the command to return exit code 2 in case of no files are affected.

| +| --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 |

[Optional]
Set to true to skip TLS certificates verification.

| +| --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

| | --include |

[Optional]
List of fields in the form of "value1;value2;...".
Only the path and the fields that are specified will be returned. The fields must be part of the 'items' AQL domain. for the full supported items list check AQL documentation

| @@ -480,15 +480,15 @@ This command is used for setting properties on existing files in Artifactory. | --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 |

[Optional]
When true, the properties will also be set on folders (and not just files) in Artifactory.

| -| --fail-no-op |

[Optional]
Set to true if you'd like the command to return exit code 2 in case of no files are affected.

| +| --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]
A list of semicolon-separated fields to sort by. The fields must be part of the 'items' AQL domain. For more information read the AQL 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 |

[Optional]
Set to true to skip TLS certificates verification.

| +| --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.

| @@ -535,15 +535,15 @@ This command is used for deleting properties from existing files in Artifactory. | --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 |

[Optional]
When true, the properties will also be set on folders (and not just files) in Artifactory.

| -| --fail-no-op |

[Optional]
Set to true if you'd like the command to return exit code 2 in case of no files are affected.

| +| --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]
A list of semicolon-separated fields to sort by. The fields must be part of the 'items' AQL domain. For more information read the AQL 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 |

[Optional]
Set to true to skip TLS certificates verification.

| +| --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

| diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/package-managers-integration.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/package-managers-integration.md index f8cdf76..6b50a4f 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/package-managers-integration.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/package-managers-integration.md @@ -23,7 +23,7 @@ Before using the **jf mvn** command, the project needs to be pre-configured with | --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 |

[Optional]
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.

| +| --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 | @@ -48,7 +48,7 @@ The following table lists the command arguments and flags: | --build-name |

[Optional]
Build name. For more details, please refer to Build Integration.

| | --build-number |

[Optional]
Build number. For more details, please refer to Build Integration.

| | --project |

[Optional]
JFrog project key.

| -| --insecure-tls |

[Optional]
Set to true to skip TLS certificates verification.

| +| --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 @@ -82,8 +82,8 @@ Before using the **gradle** command, the project needs to be pre-configured with | --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 |

[Optional]
Set to true if the Gradle Artifactory Plugin is already applied in the build script.

| -| --use-wrapper |

[Optional]
Set to true if you'd like to use the Gradle wrapper.

| +| --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.

| @@ -182,7 +182,7 @@ The following table lists the command arguments and flags: | --build-number |

[Optional]
Build number. For more details, please refer to Build Integration.

| | --project |

[Optional]
JFrog project key.

| | --module |

[Optional]
Optional module name for the build-info.

| -| --skip-login |

[Optional]
Set to true if you'd like the command to skip performing docker login.

| +| --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/ | #### Example @@ -213,9 +213,9 @@ The following table lists the command arguments and flags: | --build-number |

[Optional]
Build number. For more details, please refer to Build Integration.

| | --project |

[Optional]
JFrog project key.

| | --module |

[Optional]
Optional module name for the build-info.

| -| --skip-login |

[Optional]
Set to true if you'd like the command to skip performing docker login.

| +| --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 |

[Optional]
Set true to include a list of the affected files as part of the command output summary.

| +| --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/ | #### Example @@ -246,7 +246,7 @@ The following table lists the command arguments and flags: | --build-number |

[Optional]
Build number. For more details, please refer to Build Integration.

| | --project |

[Optional]
JFrog project key.

| | --module |

[Optional]
Optional module name for the build-info.

| -| --skip-login |

[Optional]
Set to true if you'd like the command to skip performing docker login.

| +| --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. | @@ -279,9 +279,9 @@ The following table lists the command arguments and flags: | --build-number |

[Optional]
Build number. For more details, please refer to Build Integration.

| | --project |

[Optional]
JFrog project key.

| | --module |

[Optional]
Optional module name for the build-info.

| -| --skip-login |

[Optional]
Set to true if you'd like the command to skip performing docker login.

| +| --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 |

[Optional]
Set to true to include a list of the affected files as part of the command output summary.

| +| --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. | @@ -328,7 +328,7 @@ The **build-docker-create** command allows adding a docker image, which is alrea | --build-number |

[Optional]
Build number. For more details, please refer to Build Integration.

| | --project |

[Optional]
JFrog project key.

| | --module |

[Optional]
Optional module name for the build-info.

| -| --skip-login |

[Optional]
Set to true if you'd like the command to skip performing docker login.

| +| --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. | @@ -360,7 +360,7 @@ The following table lists the command arguments and flags: | 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 |

[Optional]
If set true, the Docker image is copied to the target repository, otherwise it is moved.

| +| --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.

| @@ -479,7 +479,7 @@ The following table lists the command arguments and flags: | --build-number |

[Optional]
Build number. For more details, please refer to Build Integration.

| | --project |

[Optional]
JFrog project key.

| | --module |

[Optional]
Optional module name for the build-info.

| -| --detailed-summary |

[Optional]
Set true to include a list of the affected files as part of the command output summary.

| +| --detailed-summary |

[Default: false]
Set true to include a list of the affected files as part of the command output summary.

| | --scan |

[Optional]
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 the **npm pack** command expects. | @@ -670,7 +670,7 @@ The following table lists the command arguments and flags: | --build-number |

[Optional]
Build number. For more details, please refer to Build Integration.

| | --project |

[Optional]
JFrog project key.

| | --module |

[Optional]
Optional module name for the build-info.

| -| --detailed-summary |

[Optional]
Set true to include a list of the affected files as part of the command output summary.

| +| --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 | diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/release-lifecycle-management.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/release-lifecycle-management.md index 13f45a7..9f18217 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/release-lifecycle-management.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/release-lifecycle-management.md @@ -104,7 +104,7 @@ The file spec may be of one of the following creation sources: | --signing-key |

[Mandatory]
The GPG/RSA key-pair name given in Artifactory.

| | --spec |

[Optional]
Path to a File Spec.

| | --spec-vars |

[Optional]
List of variables in the form of "key1=value1;key2=value2;..." (wrapped by quotes) to be replaced in the File Spec. In the File Spec, the variables should be used as follows: ${key1}.

| -| --sync |

[Optional]
Set to true to run synchronously.

| +| --sync |

[Default: false]
Set to true to run synchronously.

| | Command arguments | | | release bundle name | Name of the newly created Release Bundle. | | release bundle version | Version of the newly created Release Bundle. | @@ -150,7 +150,7 @@ This command allows promoting a release bundle to a target environment. | --project |

[Optional]
Project key associated with the Release Bundle version.

| | --server-id |

[Optional]
Platform server ID configured using the config command.

| | --signing-key |

[Mandatory]
The GPG/RSA key-pair name given in Artifactory.

| -| --sync |

[Optional]
Set to true to run synchronously.

| +| --sync |

[Default: false]
Set to true to run synchronously.

| | Command arguments | | | release bundle name | Name of the Release Bundle to promote. | | release bundle version | Version of the Release Bundle to promote. | @@ -202,14 +202,14 @@ This command distributes a release bundle to an edge node. | --country-codes |

[Default: *]
Semicolon-separated list of wildcard filters for site country codes.

| | --create-repo |

[Optional]
Set to true to create the repository on the edge if it does not exist.

| | --dist-rules |

[Optional]
Path to a file, which includes the Distribution Rules in a JSON format. See the "Distribution Rules Structure" bellow.

| -| --dry-run |

[Optional]
Set to true to disable communication with JFrog Distribution.

| +| --dry-run |

[Default: false]
Set to true to disable communication with JFrog Distribution.

| | --mapping-pattern |

[Optional]
Specify along with 'mapping-target' to distribute artifacts to a different path on the edge node. You can use wildcards to specify multiple artifacts.

| | --mapping-target |

[Optional]
The target path for distributed artifacts on the edge node. If not specified, the artifacts will have the same path and name on the edge node, as on the source Artifactory server. For flexibility in specifying the distribution path, you can include [placeholders](https://www.jfrog.com/confluence/display/CLI/CLI+for+JFrog+Artifactory#CLIforJFrogArtifactory-UsingPlaceholders) in the form of {1}, {2} which are replaced by corresponding tokens in the pattern path that are enclosed in parenthesis.

| | --max-wait-minutes |

[Default: 60]
Max minutes to wait for sync distribution.

| | --project |

[Optional]
Project key associated with the Release Bundle version.

| | --server-id |

[Optional]
Platform server ID configured using the config command.

| | --site |

[Default: *]
Wildcard filter for site name.

| -| --sync |

[Optional]
Set to true to run synchronously.

| +| --sync |

[Default: false]
Set to true to run synchronously.

| | Command arguments | | | release bundle name | Name of the release bundle to distribute. | | release bundle version | Version of the release bundle to distribute. | @@ -275,7 +275,7 @@ Deleting locally means distributions of the release bundle will not be deleted. | --project |

[Optional]
Project key associated with the Release Bundle version.

| | --quiet |

[Default: $CI]
Set to true to skip the delete confirmation message.

| | --server-id |

[Optional]
Platform server ID configured using the config command.

| -| --sync |

[Optional]
Set to true to run synchronously.

| +| --sync |

[Default: false]
Set to true to run synchronously.

| | Command arguments | | | release bundle name | Name of the release bundle to distribute. | | release bundle version | Version of the release bundle to distribute. | @@ -309,13 +309,13 @@ This command will delete distributions of a release bundle from edge nodes. | --city |

[Default: *]
Wildcard filter for site city name.

| | --country-codes |

[Default: *]
Semicolon-separated list of wildcard filters for site country codes.

| | --dist-rules |

[Optional]
Path to a file, which includes the Distribution Rules in a JSON format. See the "Distribution Rules Structure" bellow.

| -| --dry-run |

[Optional]
Set to true to disable communication with JFrog Distribution.

| +| --dry-run |

[Default: false]
Set to true to disable communication with JFrog Distribution.

| | --max-wait-minutes |

[Default: 60]
Max minutes to wait for sync distribution.

| | --project |

[Optional]
Project key associated with the Release Bundle version.

| | --quiet |

[Default: $CI]
Set to true to skip the delete confirmation message.

| | --server-id |

[Optional]
Platform server ID configured using the config command.

| | --site |

[Default: *]
Wildcard filter for site name.

| -| --sync |

[Optional]
Set to true to run synchronously.

| +| --sync |

[Default: false]
Set to true to run synchronously.

| | Command arguments | | | release bundle name | Name of the release bundle to distribute. | | release bundle version | Version of the release bundle to distribute. | diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/verifying-artifactory-accessibility.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/verifying-artifactory-accessibility.md index 8fb697e..c39866d 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/verifying-artifactory-accessibility.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/verifying-artifactory-accessibility.md @@ -12,7 +12,7 @@ This command can be used to verify that Artifactory is accessible by sending an | Command options | | | --url |

[Optional]
Artifactory URL.

| | --server-id |

[Optional]
Server ID configured using the jf c add command. If not specified, the default configured Artifactory server is used.

| -| --insecure-tls |

[Optional]
Set to true to skip TLS certificates verification.

| +| --insecure-tls |

[Default: false]
Set to true to skip TLS certificates verification.

| | Command arguments | The command accepts no arguments. | ## Examples diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-distribution.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-distribution.md index 50ce4b8..1e30afd 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-distribution.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-distribution.md @@ -44,16 +44,16 @@ This commands creates and updates an unsigned Release Bundle on JFrog Distributi | --spec-vars |

[Optional]
List 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}.

| | --target-props |

[Optional]
The list of properties, in the form of key1=value1;key2=value2,..., to be added to the artifacts after distribution of the release bundle.

| | --target |

[Optional]
The target path for distributed artifacts on the edge node. If not specified, the artifacts will have the same path and name on the edge node, as on the source Artifactory server. For flexibility in specifying the distribution path, you can include placeholders in the form of {1}, {2} which are replaced by corresponding tokens in the pattern path that are enclosed in parenthesis.

| -| --dry-run |

[Optional]
Set to true to disable communication with JFrog Distribution.

| -| --sign |

[Optional]
If set to true, automatically signs the release bundle version.

| +| --dry-run |

[Default: false]
Set to true to disable communication with JFrog Distribution.

| +| --sign |

[Default: false]
If set to true, automatically signs the release bundle version.

| | --passphrase |

[Optional]
The passphrase for the signing key.

| | --desc |

[Optional]
Description of the release bundle.

| | --release-notes-path |

[Optional]
Path to a file describes the release notes for the release bundle version.

| | --release-notes-syntax |

[Default: plain_text]
The syntax for the release notes. Can be one of markdown, asciidoc, or plain_text.

| | --exclusions |

[Optional]
A list of Semicolon-separated exclude path patterns, to be excluded from the Release Bundle. Allows using wildcards.

| | --repo |

[Optional]
A repository name at source Artifactory to store release bundle artifacts in. If not provided, Artifactory will use the default one.

| -| --insecure-tls |

[Optional]
Set to true to skip TLS certificates verification.

| -| --detailed-summary |

[Optional]
Set to true to return the SHA256 value of the release bundle manifest.

| +| --insecure-tls |

[Default: false]
Set to true to skip TLS certificates verification.

| +| --detailed-summary |

[Default: false]
Set to true to return the SHA256 value of the release bundle manifest.

| | Command arguments | | | release bundle name | The name of the release bundle. | | release bundle version | The release bundle version. | @@ -188,8 +188,8 @@ This command GPG signs an existing Release Bundle on JFrog Distribution. | --server-id |

[Optional]
Artifactory server ID configured using the config command.

| | --passphrase |

[Optional]
The passphrase for the signing key.

| | --repo |

[Optional]
A repository name at source Artifactory to store release bundle artifacts in. If not provided, Artifactory will use the default one.

| -| --insecure-tls |

[Optional]
Set to true to skip TLS certificates verification.

| -| --detailed-summary |

[Optional]
Set to true to return the SHA256 value of the release bundle manifest.

| +| --insecure-tls |

[Default: false]
Set to true to skip TLS certificates verification.

| +| --detailed-summary |

[Default: false]
Set to true to return the SHA256 value of the release bundle manifest.

| | Command arguments | | | release bundle name | The name of the release bundle. | | release bundle version | The release bundle version. | @@ -222,15 +222,15 @@ This command distributes a release bundle to the Edge Nodes. | Abbreviation | rbd | | Command options | | | --server-id |

[Optional]
Artifactory server ID configured using the config command.

| -| --sync |

[Optional]
Set to true to enable sync distribution (the command execution will end when the distribution process ends).

| +| --sync |

[Default: false]
Set to true to enable sync distribution (the command execution will end when the distribution process ends).

| | --max-wait-minutes |

[Default: 60]
Max minutes to wait for sync distribution.

| | --create-repo |

[Optional]
Set to true to create the repository on the edge if it does not exist.

| -| --dry-run |

[Optional]
Set to true to disable communication with JFrog Distribution.

| +| --dry-run |

[Default: false]
Set to true to disable communication with JFrog Distribution.

| | --dist-rules |

[Optional]
Path to a file, which includes the Distribution Rules in a JSON format.

Distribution Rules JSON structure

{
"distribution_rules": [
{
"site_name": "DC-1",
"city_name": "New-York",
"country_codes": ["1"]
},
{
"site_name": "DC-2",
"city_name": "Tel-Aviv",
"country_codes": ["972"]
}
]
}

The Distribution Rules format also supports wildcards. For example:

{
"distribution_rules": [
{
"site_name": "",
"city_name": "",
"country_codes": ["*"]
}
]
}

| | --site |

[Default: *]
Wildcard filter for site name.

| | --city |

[Default: *]
Wildcard filter for site city name.

| | --country-codes |

[Default: *]
Semicolon-separated list of wildcard filters for site country codes.

| -| --insecure-tls |

[Optional]
Set to true to skip TLS certificates verification.

| +| --insecure-tls |

[Default: false]
Set to true to skip TLS certificates verification.

| | Command arguments | | | release bundle name | The name of the release bundle. | | release bundle version | The release bundle version. | @@ -264,16 +264,16 @@ This command deletes a Release Bundle from the Edge Nodes and optionally from Di | Abbreviation | rbdel | | Command options | | | --server-id |

[Optional]
Artifactory server ID configured using the config command.

| -| --sync |

[Optional]
Set to true to enable sync deletion (the command execution will end when the deletion process ends).

| +| --sync |

[Default: false]
Set to true to enable sync deletion (the command execution will end when the deletion process ends).

| | --max-wait-minutes |

[Default: 60]
Max minutes to wait for sync deletion.

| -| --dry-run |

[Optional]
Set to true to disable communication with JFrog Distribution.

| +| --dry-run |

[Default: false]
Set to true to disable communication with JFrog Distribution.

| | --dist-rules |

[Optional]
Path to a file, which includes the distribution rules in a JSON format.

| | --site |

[Default: *]
Wildcard filter for site name.

| | --city |

[Default: *]
Wildcard filter for site city name.

| | --country-codes |

[Default: *]
Semicolon-separated list of wildcard filters for site country codes.

| | --delete-from-dist |

[Optional]
Set to true to delete release bundle version in JFrog Distribution itself after deletion is complete in the specified Edge nodes.

| -| --quiet |

[Optional]
Set to true to skip the delete confirmation message.

| -| --insecure-tls |

[Optional]
Set to true to skip TLS certificates verification.

| +| --quiet |

[Default: false]
Set to true to skip the delete confirmation message.

| +| --insecure-tls |

[Default: false]
Set to true to skip TLS certificates verification.

| | Command arguments | | | release bundle name | The name of the release bundle. | | release bundle version | The release bundle version. | diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-security/download-updates-for-xrays-database.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-security/download-updates-for-xrays-database.md index 8784fdf..73f5515 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-security/download-updates-for-xrays-database.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-security/download-updates-for-xrays-database.md @@ -2,4 +2,4 @@ The offline-update command downloads updates to Xray's vulnerabilities database. The Xray UI allows building the command structure for you. -
Command namexr offline-update
Abbreviationxr ou
Command options
--license-id[Mandatory]
Xray license ID.
--from[Optional]
From update date in YYYY-MM-DD format.
--to[Optional]
To update date in YYYY-MM-DD format.
--version[Optional]
Xray API version.
--target[Default: ./]
Path for downloaded update files.
--dbsyncv3[Optional]
Set to true to use Xray DBSync V3.
--periodic[Optional]
Set to true to get the Xray DBSync V3 Periodic Package (Use with dbsyncv3 flag).
Command argumentsThe command accepts no arguments.
+
Command namexr offline-update
Abbreviationxr ou
Command options
--license-id[Mandatory]
Xray license ID.
--from[Optional]
From update date in YYYY-MM-DD format.
--to[Optional]
To update date in YYYY-MM-DD format.
--version[Optional]
Xray API version.
--target[Default: ./]
Path for downloaded update files.
--dbsyncv3[Default: false]
Set to true to use Xray DBSync V3.
--periodic[Default: false]
Set to true to get the Xray DBSync V3 Periodic Package (Use with dbsyncv3 flag).
Command argumentsThe command accepts no arguments.
diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-published-builds.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-published-builds.md index 58ca727..856db9c 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-published-builds.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-published-builds.md @@ -16,7 +16,7 @@ JFrog CLI is integrated with JFrog Xray and JFrog Artifactory, allowing you to h | --fail |

[Default: true]
When set, the command returns exit code 3 if a 'Fail Build' rule is matched by Xray.
Set to false if you do not wish the command to return exit code 3 in such case, and an exit code 0 will be returned.

| | --format |

[Default: table]
Defines the output format of the command. The accepted values are: table and json.

| | --project |

[Optional]
JFrog project key

| -| --rescan |

[Optional]
Set to true when scanning an already successfully scanned build, for example after adding an ignore rule.

| +| --rescan |

[Default: false]
Set to true when scanning an already successfully scanned build, for example after adding an ignore rule.

| | Command arguments | The command accepts two arguments. | | Build name | Build name to be scanned. | | Build number | Build number to be scanned. | diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-your-binaries.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-your-binaries.md index 0c160d8..eba1007 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-your-binaries.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-your-binaries.md @@ -29,7 +29,7 @@ This _**jf scan**_ command scans files on the local file system with Xray. | --project |

[Optional]
JFrog project key, to enable Xray to determine security violations accordingly. The command accepts this option only if the --repo-path and --watches options are not provided. If none of the three options are provided, the command will show all known vulnerabilities.

| | --repo-path |

[Optional]
Artifactory repository path in the form of <repository>/<path in the repository>, to enable Xray to determine violations accordingly. The command accepts this option only if the --project and --watches options are not provided. If none of the three options are provided, the command will show all known vulnerabilities.

| | --watches |

[Optional]
A comma-separated list of Xray watches, to enable Xray to determine violations accordingly. The command accepts this option only if the --project and --repo-path options are not provided. If none of the three options are provided, the command will show all known vulnerabilities.

| -| --licenses |

[Optional]
Set if you also require the list of licenses to be displayed.

| +| --licenses |

[Default: false]
Set if you also require the list of licenses to be displayed.

| | --format=json |

[Optional]
Produces a JSON file containing the scan results.

| | **Command arguments** | | | **Pattern** | Specifies the local file system path to artifacts to be scanned. You can specify multiple files by using wildcards. | @@ -108,7 +108,7 @@ This j\_**f docker scan**\_ command scans docker containers located on the local | --project |

[Optional]
JFrog project key, to enable Xray to determine security violations accordingly. The command accepts this option only if the --repo-path and --watches options are not provided. If none of the three options are provided, the command will show all known vulnerabilities.

| | --repo-path |

[Optional]
Artifactory repository path in the form of <repository>/<path in the repository>, to enable Xray to determine violations accordingly. The command accepts this option only if the --project and --watches options are not provided. If none of the three options are provided, the command will show all known vulnerabilities.

| | --watches |

[Optional]
A comma separated list of Xray watches, to enable Xray to determine violations accordingly. The command accepts this option only if the --repo-path and --repo-path options are not provided. If none of the three options are provided, the command will show all known vulnerabilities.

| -| --licenses |

[Optional]
Set if you also require the list of licenses to be displayed.

| +| --licenses |

[Default: false]
Set if you also require the list of licenses to be displayed.

| | --format=json |

[Optional]
Produces a JSON file containing the scan results.

| | **Command arguments** | | | **Pattern** | Specifies the local file system path to artifacts to be scanned. You can specify multiple files by using wildcards. | diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-your-source-code.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-your-source-code.md index 1a5434c..e709277 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-your-source-code.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-your-source-code.md @@ -44,7 +44,7 @@ This command also supports the following Advanced Scans with the **Advanced Secu | --project |

[Optional]
JFrog project key, to enable Xray to determine security violations accordingly. The command accepts this option only if the --repo-path and --watches options are not provided. If none of the three options are provided, the command will show all known vulnerabilities

| | --repo-path |

[Optional]
Artifactory repository path in the form of <repository>/<path in the repository>, to enable Xray to determine violations accordingly. The command accepts this option only if the --project and --watches options are not provided. If none of the three options are provided, the command will show all known vulnerabilities

| | --watches |

[Optional]
A comma-separated list of Xray watches, to enable Xray to determine violations accordingly. The command accepts this option only if the --repo-path and --repo-path options are not provided. If none of the three options are provided, the command will show all known vulnerabilities

| -| --licenses |

[Optional]
Set if you'd also like the list of licenses to be displayed.

| +| --licenses |

[Default: false]
Set if you'd also like the list of licenses to be displayed.

| | --format |

[Default: table]
Defines the output format of the command. Acceptable values are: table and json.

| | --fail |

[Default: true]
Set to false if you do not wish the command to return exit code 3, even if the 'Fail Build' rule is matched by Xray.

| | --use-wrapper |

[Default: false] [Gradle]
Set to true if you'd like to use the Gradle wrapper.

| @@ -55,15 +55,15 @@ This command also supports the following Advanced Scans with the **Advanced Secu | --exclusions |

[Default: *.git*;*node_modules*;*target*;*venv*;*test*]
List of exclusions separated by semicolons, utilized to skip sub-projects from undergoing an audit. These exclusions may incorporate the * and ? wildcards.

| | --fixable-only |

[Optional]
Set to true if you wish to display issues that have a fix version only.

| | --min-severity |

[Optional]
Set the minimum severity of issues to display. The following values are accepted: Low, Medium, High or Critical

| -| --go |

[Optional]
Set to true to request audit for a Go project.

| -| --gradle |

[Optional]
Set to true to request audit for a Gradle project.

| -| --mvn |

[Optional]
Set to true to request audit for a Maven project.

| -| --npm |

[Optional]
Set to true to request audit for a npm project.

| -| --pnpm |

[Optional]
Set to true to request audit for a pnpm project.

| -| --nuget |

[Optional]
Set to true to request audit for a .Net project.

| -| --pip |

[Optional]
Set to true to request audit for a Pip project.

| -| --pipenv |

[Optional]
Set to true to request audit for a Pipenv project.

| -| --yarn |

[Optional]
Set to true to request audit for a Yarn project.

| +| --go |

[Default: false]
Set to true to request audit for a Go project.

| +| --gradle |

[Default: false]
Set to true to request audit for a Gradle project.

| +| --mvn |

[Default: false]
Set to true to request audit for a Maven project.

| +| --npm |

[Default: false]
Set to true to request audit for a npm project.

| +| --pnpm |

[Default: false]
Set to true to request audit for a pnpm project.

| +| --nuget |

[Default: false]
Set to true to request audit for a .Net project.

| +| --pip |

[Default: false]
Set to true to request audit for a Pip project.

| +| --pipenv |

[Default: false]
Set to true to request audit for a Pipenv project.

| +| --yarn |

[Default: false]
Set to true to request audit for a Yarn project.

| | **Command arguments** | The command accepts no arguments | #### **Output Example** diff --git a/jfrog-applications/jfrog-cli/get-started/configurations/jfrog-platform-configuration.md b/jfrog-applications/jfrog-cli/get-started/configurations/jfrog-platform-configuration.md index 9222c55..a8647cc 100644 --- a/jfrog-applications/jfrog-cli/get-started/configurations/jfrog-platform-configuration.md +++ b/jfrog-applications/jfrog-cli/get-started/configurations/jfrog-platform-configuration.md @@ -74,7 +74,7 @@ The **config add** and **config edit** commands are used to add and edit JFrog P | --url |

[Optional]

JFrog platform URL.

| | --user |

[Optional]

JFrog Platform username.

| | --xray-url | \[Optional] Xray URL. | -| --overwrite |

[Available for config add only]
[Optional]
Overwrites the instance configuration if an instance with the same ID already exists.

| +| --overwrite |

[Available for config add only]
[Default: false]
Overwrites the instance configuration if an instance with the same ID already exists.

| | Command arguments | | | server ID | A unique ID for the server configuration. | From 460369d8ecb838fe700e898a1f3c88c9f5c6de9b Mon Sep 17 00:00:00 2001 From: Michael Sverdlov Date: Mon, 15 Apr 2024 11:02:31 +0300 Subject: [PATCH 5/9] fix docs --- .../package-managers-integration.md | 6 +++--- .../release-lifecycle-management.md | 2 +- jfrog-applications/jfrog-cli/cli-for-jfrog-distribution.md | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/package-managers-integration.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/package-managers-integration.md index 6b50a4f..0cf57cf 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/package-managers-integration.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/package-managers-integration.md @@ -88,7 +88,7 @@ Before using the **gradle** command, the project needs to be pre-configured with | --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 |

[Optional]
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.

| +| --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 | @@ -480,7 +480,7 @@ The following table lists the command arguments and flags: | --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 |

[Optional]
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.

| +| --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 the **npm pack** command expects. | @@ -625,7 +625,7 @@ The following table lists the command arguments and flags: | --build-name |

[Optional]
Build name. For more details, please refer to Build Integration.

| | --build-number |

[Optional]
Build number. For more details, please refer to Build Integration.

| | --project |

[Optional]
JFrog project key.

| -| --no-fallback |

[Optional]
Set to avoid downloading packages from the VCS, if they are missing in Artifactory.

| +| --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. | diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/release-lifecycle-management.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/release-lifecycle-management.md index 9f18217..6885b2f 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/release-lifecycle-management.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/release-lifecycle-management.md @@ -200,7 +200,7 @@ This command distributes a release bundle to an edge node. | Command options | | | --city |

[Default: *]
Wildcard filter for site city name.

| | --country-codes |

[Default: *]
Semicolon-separated list of wildcard filters for site country codes.

| -| --create-repo |

[Optional]
Set to true to create the repository on the edge if it does not exist.

| +| --create-repo |

[Default: false]
Set to true to create the repository on the edge if it does not exist.

| | --dist-rules |

[Optional]
Path to a file, which includes the Distribution Rules in a JSON format. See the "Distribution Rules Structure" bellow.

| | --dry-run |

[Default: false]
Set to true to disable communication with JFrog Distribution.

| | --mapping-pattern |

[Optional]
Specify along with 'mapping-target' to distribute artifacts to a different path on the edge node. You can use wildcards to specify multiple artifacts.

| diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-distribution.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-distribution.md index 1e30afd..97a675c 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-distribution.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-distribution.md @@ -224,7 +224,7 @@ This command distributes a release bundle to the Edge Nodes. | --server-id |

[Optional]
Artifactory server ID configured using the config command.

| | --sync |

[Default: false]
Set to true to enable sync distribution (the command execution will end when the distribution process ends).

| | --max-wait-minutes |

[Default: 60]
Max minutes to wait for sync distribution.

| -| --create-repo |

[Optional]
Set to true to create the repository on the edge if it does not exist.

| +| --create-repo |

[Default: false]
Set to true to create the repository on the edge if it does not exist.

| | --dry-run |

[Default: false]
Set to true to disable communication with JFrog Distribution.

| | --dist-rules |

[Optional]
Path to a file, which includes the Distribution Rules in a JSON format.

Distribution Rules JSON structure

{
"distribution_rules": [
{
"site_name": "DC-1",
"city_name": "New-York",
"country_codes": ["1"]
},
{
"site_name": "DC-2",
"city_name": "Tel-Aviv",
"country_codes": ["972"]
}
]
}

The Distribution Rules format also supports wildcards. For example:

{
"distribution_rules": [
{
"site_name": "",
"city_name": "",
"country_codes": ["*"]
}
]
}

| | --site |

[Default: *]
Wildcard filter for site name.

| @@ -271,7 +271,7 @@ This command deletes a Release Bundle from the Edge Nodes and optionally from Di | --site |

[Default: *]
Wildcard filter for site name.

| | --city |

[Default: *]
Wildcard filter for site city name.

| | --country-codes |

[Default: *]
Semicolon-separated list of wildcard filters for site country codes.

| -| --delete-from-dist |

[Optional]
Set to true to delete release bundle version in JFrog Distribution itself after deletion is complete in the specified Edge nodes.

| +| --delete-from-dist |

[Default: false]
Set to true to delete release bundle version in JFrog Distribution itself after deletion is complete in the specified Edge nodes.

| | --quiet |

[Default: false]
Set to true to skip the delete confirmation message.

| | --insecure-tls |

[Default: false]
Set to true to skip TLS certificates verification.

| | Command arguments | | From 899e60218c6f2abc965795fa5e697dd3b7c97e24 Mon Sep 17 00:00:00 2001 From: Michael Sverdlov Date: Mon, 15 Apr 2024 11:09:44 +0300 Subject: [PATCH 6/9] fix docs --- jfrog-applications/SUMMARY.md | 4 +- .../build-integration.md | 50 +++++------ .../environment-variables.md | 4 +- .../generic-files.md | 84 +++++++++---------- .../package-managers-integration.md | 60 ++++++------- .../release-lifecycle-management.md | 74 ++++++++-------- .../verifying-artifactory-accessibility.md | 2 +- .../jfrog-cli/cli-for-jfrog-distribution.md | 48 +++++------ .../scan-published-builds.md | 16 ++-- .../scan-your-binaries.md | 28 +++---- .../scan-your-source-code.md | 14 ++-- .../jfrog-platform-configuration.md | 18 ++-- .../configurations/proxy-support.md | 2 +- .../get-started/download-and-install/usage.md | 2 +- 14 files changed, 203 insertions(+), 203 deletions(-) diff --git a/jfrog-applications/SUMMARY.md b/jfrog-applications/SUMMARY.md index e806bd7..d716699 100644 --- a/jfrog-applications/SUMMARY.md +++ b/jfrog-applications/SUMMARY.md @@ -71,13 +71,13 @@ * [Setup Frogbot Using GitLab CI](frogbot/setup-frogbot-using-gitlab-ci.md) * [Setup Frogbot Using Azure Pipelines](frogbot/setup-frogbot-using-azure-pipelines.md) * [Scan Pull Requests](jfrog-applications/frogbot/scan-pull-requests/README.md) - * [Scan Github Pull Request](jfrog-applications/frogbot/scan-pull-requests/scan-github-pull-request.md) + * [Scan GitHub Pull Request](jfrog-applications/frogbot/scan-pull-requests/scan-github-pull-request.md) * [Scan Gitlab Pull Request](jfrog-applications/frogbot/scan-pull-requests/scan-gitlab-pull-request.md) * [Scan Azure Repos Pull Request](jfrog-applications/frogbot/scan-pull-requests/scan-azure-repos-pull-request.md) * [Scan Bitbucket Server Pull Request](jfrog-applications/frogbot/scan-pull-requests/scan-bitbucket-server-pull-request.md) * [Pull Request Scan Results](jfrog-applications/frogbot/scan-pull-requests/pull-request-scan-results.md) * [Scan Git Repositories](jfrog-applications/frogbot/scan-repositories/README.md) - * [View Security Alerts on Github](jfrog-applications/frogbot/scan-repositories/view-security-alerts-on-github.md) + * [View Security Alerts on GitHub](jfrog-applications/frogbot/scan-repositories/view-security-alerts-on-github.md) * [Frogbot Badge](frogbot/frogbot-badge.md) ## CI & SDKs diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/build-integration.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/build-integration.md index 0f76c4d..4c81a7c 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/build-integration.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/build-integration.md @@ -143,13 +143,13 @@ By default, the command collects the files from the local file system. If you'd | 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.

| +| --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]
List 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.

| +| --dry-run |

[Default: false]
Set to true to only get a summery of the dependencies that will be added to the build info.

| | --module |

[Optional]
Optional module name in the build-info for adding the dependency.

| | --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 three arguments. | @@ -203,8 +203,8 @@ jf rt bp my-build-name 18 | --build-url |

[Optional]
Can be used for setting the CI server build URL in the build-info.

| | --env-include |

[Default: *]
List 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*]
List 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.

| +| --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. | @@ -298,25 +298,25 @@ This command is used to [promote build](https://jfrog.com/knowledge-base/how-doe ### Commands Params -| | | -|------------------------|------------------------------------------------------------------------------------------------------------------------------------------| -| 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]
List 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. | +| | | +|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------| +| 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]
List 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 @@ -369,8 +369,8 @@ The following table lists the command arguments and flags: | --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]
List 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.

| +| --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. | diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/environment-variables.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/environment-variables.md index 9fce278..cc8d133 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/environment-variables.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/environment-variables.md @@ -16,8 +16,8 @@ Some of the Artifactory commands make use of the following environment variable: | **JFROG\_CLI\_BUILD\_PROJECT** | JFrog project key to be used by commands that expect build name and build number. Determines the project of the published build. | | **JFROG\_CLI\_BUILD\_URL** | Sets the CI server build URL in the build-info. The "jf rt build-publish" command uses the value of this environment variable unless the --build-url command option is sent. | | **JFROG\_CLI\_ENV\_EXCLUDE** |

[Default: *password*;*secret*;*key*;*token*]
List of case insensitive patterns in the form of "value1;value2;...". Environment variables match those patterns will be excluded. This environment variable is used by the "jf rt build-publish" command, in case the --env-exclude command option is not sent.

| -| **JFROG\_CLI\_TRANSITIVE\_DOWNLOAD\_EXPERIMENTAL** |

[Default: false]
Used by the "jf rt download" command. Set to true to download artifacts also from remote repositories. This feature is experimental and available on Artifactory version 7.17.0 or higher.

| -| **JFROG\_CLI\_UPLOAD\_EMPTY\_ARCHIVE** |

[Default: false]
Used by the "jf rt upload" command. Set to true if you'd like to upload an empty archive when '--archive' is set but all files were excluded by exclusions pattern.

| +| **JFROG\_CLI\_TRANSITIVE\_DOWNLOAD\_EXPERIMENTAL** |

[Default: false]
Used by the "jf rt download" command. Set to true to download artifacts also from remote repositories. This feature is experimental and available on Artifactory version 7.17.0 or higher.

| +| **JFROG\_CLI\_UPLOAD\_EMPTY\_ARCHIVE** |

[Default: false]
Used by the "jf rt upload" command. Set to true if you'd like to upload an empty archive when '--archive' is set but all files were excluded by exclusions pattern.

| *** diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/generic-files.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/generic-files.md index 112259a..c885e15 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/generic-files.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/generic-files.md @@ -29,23 +29,23 @@ This command is used to upload files to Artifactory. | --module |

[Optional]
Optional module name for the build-info.

| | --target-props |

[Optional]
A list of Artifactory properties specified 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".

| | --deb |

[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.

If Using Placeholders are used, the value of this option is ignored.

Note

JFrog CLI v1

In JFrog CLI v1, the default value of the --flat option is true.

| +| --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.

If Using Placeholders are used, the value of this option is ignored.

Note

JFrog CLI v1

In 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.

| +| --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. The symlink file 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. Bottom-chain directories are either empty or do not include other directories that match the source path.

| +| --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. The symlink file 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. Bottom-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 --regexp and --ant options. Please read the --regexp and --ant options 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.

| +| --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.

| +| --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.

| | --min-split |

[Default: 200]
The minimum file size in MiB required to attempt a multi-part upload. This option, as well as the functionality of multi-part upload, requires Artifactory with S3 storage.

| | --split-count |

[Default: 5]
The maximum number of parts that can be concurrently uploaded per file during a multi-part upload. Set to 0 to disable multi-part upload. This option, as well as the functionality of multi-part upload, requires Artifactory with S3 storage.

| @@ -140,29 +140,29 @@ This command is used to download files from Artifactory. | --exclude-props |

[Optional]
A list of Artifactory properties specified as "key=value" pairs separated by a semi-colon (for example, "key1=value1;key2=value2;key3=value3"). Only artifacts without all of 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.

If Using Placeholders are 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.

| +| --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.

If Using Placeholders are 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 --min-split in size). To download each file in a single thread, set to 0.

| | --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 --split-count segments. Any files smaller than the specified number will be downloaded in a single thread. If set to -1, files are not split.

| -| --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.

| -| --bypass-archive-inspection |

[Default: false]
Set to true to bypass the archive security inspection before it is unarchived. Used with the 'explode' option.

| -| --validate-symlinks |

[Default: false]
If true, the command will validate that symlinks are 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. Bottom-chain directories are either empty or do not include other directories that match the source path.

| +| --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.

| +| --bypass-archive-inspection |

[Default: false]
Set to true to bypass the archive security inspection before it is unarchived. Used with the 'explode' option.

| +| --validate-symlinks |

[Default: false]
If true, the command will validate that symlinks are 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. Bottom-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.

| +| --quiet |

[Default: false]
If true, the delete confirmation message is skipped.

| | --sort-by |

[Optional]
A list of semicolon-separated fields to sort by. The fields must be part of the 'items' AQL domain. For more information read the AQL 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.

| +| --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.

| +| --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.

| @@ -224,18 +224,18 @@ This command is used to copy files in Artifactory | --exclude-props |

[Optional]
A list of Artifactory properties specified as "key=value" pairs separated by a semi-colon (for example, "key1=value1;key2=value2;key3=value3"). Only artifacts without all of 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.

| +| --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.

| +| --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]
A list of semicolon-separated fields to sort by. The fields must be part of the 'items' AQL domain. For more information read the AQL 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.

| +| --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.

| +| --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.

| @@ -289,18 +289,18 @@ This command is used to move files in Artifactory | --exclude-props |

[Optional]
A list of Artifactory properties specified as "key=value" pairs separated by a semi-colon (for example, "key1=value1;key2=value2;key3=value3"). Only artifacts without all of 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.

| +| --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.

| +| --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]
A list of semicolon-separated fields to sort by. The fields must be part of the 'items' AQL domain. For more information read the AQL 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.

| +| --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.

| +| --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.

| @@ -354,17 +354,17 @@ This command is used to delete files in Artifactory | --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.

| +| --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]
A list of semicolon-separated fields to sort by. The fields must be part of the 'items' AQL domain. For more information read the AQL 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.

| +| --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.

| +| --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

| @@ -408,7 +408,7 @@ This command is used to search and display files in Artifactory. | --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 to Using File Specs.

| | --count |

[Optional]
Set to true to display only the total of files or folders found.

| -| --include-dirs |

[Default: false]
Set to true if you'd like to also apply the source path pattern for directories and not only for files

| +| --include-dirs |

[Default: false]
Set to true if you'd like to also apply the source path pattern for directories and not only for files

| | --spec-vars |

[Optional]
List 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 Artifactory properties specified as "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 Artifactory properties specified as "key=value" pairs separated by a semi-colon (for example, "key1=value1;key2=value2;key3=value3"). Only artifacts without all of the specified properties names and values will be returned.

| @@ -421,9 +421,9 @@ This command is used to search and display files in Artifactory. | --transitive |

[Optional]
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.

| +| --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.

| +| --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

| | --include |

[Optional]
List of fields in the form of "value1;value2;...".
Only the path and the fields that are specified will be returned. The fields must be part of the 'items' AQL domain. for the full supported items list check AQL documentation

| @@ -480,15 +480,15 @@ This command is used for setting properties on existing files in Artifactory. | --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.

| +| --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]
A list of semicolon-separated fields to sort by. The fields must be part of the 'items' AQL domain. For more information read the AQL 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.

| +| --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.

| @@ -535,15 +535,15 @@ This command is used for deleting properties from existing files in Artifactory. | --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.

| +| --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]
A list of semicolon-separated fields to sort by. The fields must be part of the 'items' AQL domain. For more information read the AQL 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.

| +| --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

| diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/package-managers-integration.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/package-managers-integration.md index 0cf57cf..0f4bb3d 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/package-managers-integration.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/package-managers-integration.md @@ -23,7 +23,7 @@ Before using the **jf mvn** command, the project needs to be pre-configured with | --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.

| +| --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 | @@ -48,7 +48,7 @@ The following table lists the command arguments and flags: | --build-name |

[Optional]
Build name. For more details, please refer to Build Integration.

| | --build-number |

[Optional]
Build number. For more details, please refer to Build Integration.

| | --project |

[Optional]
JFrog project key.

| -| --insecure-tls |

[Default: false]
Set to true to skip TLS certificates verification.

| +| --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 @@ -72,25 +72,25 @@ JFrog CLI includes integration with Gradle, allowing you to resolve dependencies Before using the **gradle** command, the project needs to be pre-configured with the Artifactory server and repositories, to be used for building and publishing the project. The **gradle-config** command 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\*\*.jfrog\*\* directory 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.

| +| | | +|-------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 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.

| +| --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 | +| --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 @@ -182,7 +182,7 @@ The following table lists the command arguments and flags: | --build-number |

[Optional]
Build number. For more details, please refer to Build 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.

| +| --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/ | #### Example @@ -213,9 +213,9 @@ The following table lists the command arguments and flags: | --build-number |

[Optional]
Build number. For more details, please refer to Build 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.

| +| --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.

| +| --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/ | #### Example @@ -246,7 +246,7 @@ The following table lists the command arguments and flags: | --build-number |

[Optional]
Build number. For more details, please refer to Build 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.

| +| --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. | @@ -279,9 +279,9 @@ The following table lists the command arguments and flags: | --build-number |

[Optional]
Build number. For more details, please refer to Build 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.

| +| --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.

| +| --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. | @@ -328,7 +328,7 @@ The **build-docker-create** command allows adding a docker image, which is alrea | --build-number |

[Optional]
Build number. For more details, please refer to Build 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.

| +| --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. | @@ -360,7 +360,7 @@ The following table lists the command arguments and flags: | 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.

| +| --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.

| @@ -479,8 +479,8 @@ The following table lists the command arguments and flags: | --build-number |

[Optional]
Build number. For more details, please refer to Build 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.

| +| --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 the **npm pack** command expects. | @@ -625,7 +625,7 @@ The following table lists the command arguments and flags: | --build-name |

[Optional]
Build name. For more details, please refer to Build Integration.

| | --build-number |

[Optional]
Build number. For more details, please refer to Build Integration.

| | --project |

[Optional]
JFrog project key.

| -| --no-fallback |

[Default false]
Set to avoid downloading packages from the VCS, if they are missing in Artifactory.

| +| --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. | @@ -670,7 +670,7 @@ The following table lists the command arguments and flags: | --build-number |

[Optional]
Build number. For more details, please refer to Build 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.

| +| --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 | diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/release-lifecycle-management.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/release-lifecycle-management.md index 6885b2f..63076db 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/release-lifecycle-management.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/release-lifecycle-management.md @@ -94,20 +94,20 @@ The file spec may be of one of the following creation sources: ### Commands Params -| | | -|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Command-name | release-bundle-create | -| Abbreviation | rbc | -| Command options | | +| | | +|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Command-name | release-bundle-create | +| Abbreviation | rbc | +| Command options | | | --project |

[Optional]
Project key associated with the created Release Bundle version.

| | --server-id |

[Optional]
Platform server ID configured using the config command.

| | --signing-key |

[Mandatory]
The GPG/RSA key-pair name given in Artifactory.

| | --spec |

[Optional]
Path to a File Spec.

| | --spec-vars |

[Optional]
List of variables in the form of "key1=value1;key2=value2;..." (wrapped by quotes) to be replaced in the File Spec. In the File Spec, the variables should be used as follows: ${key1}.

| | --sync |

[Default: false]
Set to true to run synchronously.

| -| Command arguments | | -| release bundle name | Name of the newly created Release Bundle. | -| release bundle version | Version of the newly created Release Bundle. | +| Command arguments | | +| release bundle name | Name of the newly created Release Bundle. | +| release bundle version | Version of the newly created Release Bundle. | ### Examples #### Example 1 @@ -140,21 +140,21 @@ This command allows promoting a release bundle to a target environment. ### Commands Params -| | | -|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Command-name | release-bundle-promote | -| Abbreviation | rbp | -| Command options | | +| | | +|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Command-name | release-bundle-promote | +| Abbreviation | rbp | +| Command options | | | --input-repos |

[Optional]
A list of semicolon-separated repositories to include in the promotion. If this property is left undefined, all repositories (except those specifically excluded) are included in the promotion. If one or more repositories are specifically included, all other repositories are excluded.

| | --exclude-repos |

[Optional]
A list of semicolon-separated repositories to exclude from the promotion.

| | --project |

[Optional]
Project key associated with the Release Bundle version.

| | --server-id |

[Optional]
Platform server ID configured using the config command.

| | --signing-key |

[Mandatory]
The GPG/RSA key-pair name given in Artifactory.

| | --sync |

[Default: false]
Set to true to run synchronously.

| -| Command arguments | | -| release bundle name | Name of the Release Bundle to promote. | -| release bundle version | Version of the Release Bundle to promote. | -| environment | Name of the target environment for the promotion. | +| Command arguments | | +| release bundle name | Name of the Release Bundle to promote. | +| release bundle version | Version of the Release Bundle to promote. | +| environment | Name of the target environment for the promotion. | ### Examples #### Example 1 @@ -193,11 +193,11 @@ jf rbp --signing-key=myKeyPair --exclude-repos="generic-local;my-repo" myApp 1.0 This command distributes a release bundle to an edge node. -| | | -|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Command-name | release-bundle-distribute | -| Abbreviation | rbd | -| Command options | | +| | | +|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Command-name | release-bundle-distribute | +| Abbreviation | rbd | +| Command options | | | --city |

[Default: *]
Wildcard filter for site city name.

| | --country-codes |

[Default: *]
Semicolon-separated list of wildcard filters for site country codes.

| | --create-repo |

[Default: false]
Set to true to create the repository on the edge if it does not exist.

| @@ -210,9 +210,9 @@ This command distributes a release bundle to an edge node. | --server-id |

[Optional]
Platform server ID configured using the config command.

| | --site |

[Default: *]
Wildcard filter for site name.

| | --sync |

[Default: false]
Set to true to run synchronously.

| -| Command arguments | | -| release bundle name | Name of the release bundle to distribute. | -| release bundle version | Version of the release bundle to distribute. | +| Command arguments | | +| release bundle name | Name of the release bundle to distribute. | +| release bundle version | Version of the release bundle to distribute. | **Distribution Rules Structure** ```json @@ -272,10 +272,10 @@ Deleting locally means distributions of the release bundle will not be deleted. | Command-name | release-bundle-delete-local | | Abbreviation | rbdell | | Command options | | -| --project |

[Optional]
Project key associated with the Release Bundle version.

| -| --quiet |

[Default: $CI]
Set to true to skip the delete confirmation message.

| -| --server-id |

[Optional]
Platform server ID configured using the config command.

| -| --sync |

[Default: false]
Set to true to run synchronously.

| +| --project |

[Optional]
Project key associated with the Release Bundle version.

| +| --quiet |

[Default: $CI]
Set to true to skip the delete confirmation message.

| +| --server-id |

[Optional]
Platform server ID configured using the config command.

| +| --sync |

[Default: false]
Set to true to run synchronously.

| | Command arguments | | | release bundle name | Name of the release bundle to distribute. | | release bundle version | Version of the release bundle to distribute. | @@ -301,11 +301,11 @@ Delete all promotions of the release bundle to environment "PROD". ## Deleting release bundle remotely This command will delete distributions of a release bundle from edge nodes. -| | | -|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------| -| Command-name | release-bundle-delete-remote | -| Abbreviation | rbdelr | -| Command options | | +| | | +|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------| +| Command-name | release-bundle-delete-remote | +| Abbreviation | rbdelr | +| Command options | | | --city |

[Default: *]
Wildcard filter for site city name.

| | --country-codes |

[Default: *]
Semicolon-separated list of wildcard filters for site country codes.

| | --dist-rules |

[Optional]
Path to a file, which includes the Distribution Rules in a JSON format. See the "Distribution Rules Structure" bellow.

| @@ -316,9 +316,9 @@ This command will delete distributions of a release bundle from edge nodes. | --server-id |

[Optional]
Platform server ID configured using the config command.

| | --site |

[Default: *]
Wildcard filter for site name.

| | --sync |

[Default: false]
Set to true to run synchronously.

| -| Command arguments | | -| release bundle name | Name of the release bundle to distribute. | -| release bundle version | Version of the release bundle to distribute. | +| Command arguments | | +| release bundle name | Name of the release bundle to distribute. | +| release bundle version | Version of the release bundle to distribute. | ### Examples #### Example 1 diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/verifying-artifactory-accessibility.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/verifying-artifactory-accessibility.md index c39866d..3d7083f 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/verifying-artifactory-accessibility.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/verifying-artifactory-accessibility.md @@ -12,7 +12,7 @@ This command can be used to verify that Artifactory is accessible by sending an | Command options | | | --url |

[Optional]
Artifactory URL.

| | --server-id |

[Optional]
Server ID configured using the jf c add command. If not specified, the default configured Artifactory server is used.

| -| --insecure-tls |

[Default: false]
Set to true to skip TLS certificates verification.

| +| --insecure-tls |

[Default: false]
Set to true to skip TLS certificates verification.

| | Command arguments | The command accepts no arguments. | ## Examples diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-distribution.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-distribution.md index 97a675c..615dfeb 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-distribution.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-distribution.md @@ -44,16 +44,16 @@ This commands creates and updates an unsigned Release Bundle on JFrog Distributi | --spec-vars |

[Optional]
List 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}.

| | --target-props |

[Optional]
The list of properties, in the form of key1=value1;key2=value2,..., to be added to the artifacts after distribution of the release bundle.

| | --target |

[Optional]
The target path for distributed artifacts on the edge node. If not specified, the artifacts will have the same path and name on the edge node, as on the source Artifactory server. For flexibility in specifying the distribution path, you can include placeholders in the form of {1}, {2} which are replaced by corresponding tokens in the pattern path that are enclosed in parenthesis.

| -| --dry-run |

[Default: false]
Set to true to disable communication with JFrog Distribution.

| -| --sign |

[Default: false]
If set to true, automatically signs the release bundle version.

| +| --dry-run |

[Default: false]
Set to true to disable communication with JFrog Distribution.

| +| --sign |

[Default: false]
If set to true, automatically signs the release bundle version.

| | --passphrase |

[Optional]
The passphrase for the signing key.

| | --desc |

[Optional]
Description of the release bundle.

| | --release-notes-path |

[Optional]
Path to a file describes the release notes for the release bundle version.

| | --release-notes-syntax |

[Default: plain_text]
The syntax for the release notes. Can be one of markdown, asciidoc, or plain_text.

| | --exclusions |

[Optional]
A list of Semicolon-separated exclude path patterns, to be excluded from the Release Bundle. Allows using wildcards.

| | --repo |

[Optional]
A repository name at source Artifactory to store release bundle artifacts in. If not provided, Artifactory will use the default one.

| -| --insecure-tls |

[Default: false]
Set to true to skip TLS certificates verification.

| -| --detailed-summary |

[Default: false]
Set to true to return the SHA256 value of the release bundle manifest.

| +| --insecure-tls |

[Default: false]
Set to true to skip TLS certificates verification.

| +| --detailed-summary |

[Default: false]
Set to true to return the SHA256 value of the release bundle manifest.

| | Command arguments | | | release bundle name | The name of the release bundle. | | release bundle version | The release bundle version. | @@ -188,8 +188,8 @@ This command GPG signs an existing Release Bundle on JFrog Distribution. | --server-id |

[Optional]
Artifactory server ID configured using the config command.

| | --passphrase |

[Optional]
The passphrase for the signing key.

| | --repo |

[Optional]
A repository name at source Artifactory to store release bundle artifacts in. If not provided, Artifactory will use the default one.

| -| --insecure-tls |

[Default: false]
Set to true to skip TLS certificates verification.

| -| --detailed-summary |

[Default: false]
Set to true to return the SHA256 value of the release bundle manifest.

| +| --insecure-tls |

[Default: false]
Set to true to skip TLS certificates verification.

| +| --detailed-summary |

[Default: false]
Set to true to return the SHA256 value of the release bundle manifest.

| | Command arguments | | | release bundle name | The name of the release bundle. | | release bundle version | The release bundle version. | @@ -222,15 +222,15 @@ This command distributes a release bundle to the Edge Nodes. | Abbreviation | rbd | | Command options | | | --server-id |

[Optional]
Artifactory server ID configured using the config command.

| -| --sync |

[Default: false]
Set to true to enable sync distribution (the command execution will end when the distribution process ends).

| +| --sync |

[Default: false]
Set to true to enable sync distribution (the command execution will end when the distribution process ends).

| | --max-wait-minutes |

[Default: 60]
Max minutes to wait for sync distribution.

| -| --create-repo |

[Default: false]
Set to true to create the repository on the edge if it does not exist.

| -| --dry-run |

[Default: false]
Set to true to disable communication with JFrog Distribution.

| +| --create-repo |

[Default: false]
Set to true to create the repository on the edge if it does not exist.

| +| --dry-run |

[Default: false]
Set to true to disable communication with JFrog Distribution.

| | --dist-rules |

[Optional]
Path to a file, which includes the Distribution Rules in a JSON format.

Distribution Rules JSON structure

{
"distribution_rules": [
{
"site_name": "DC-1",
"city_name": "New-York",
"country_codes": ["1"]
},
{
"site_name": "DC-2",
"city_name": "Tel-Aviv",
"country_codes": ["972"]
}
]
}

The Distribution Rules format also supports wildcards. For example:

{
"distribution_rules": [
{
"site_name": "",
"city_name": "",
"country_codes": ["*"]
}
]
}

| | --site |

[Default: *]
Wildcard filter for site name.

| | --city |

[Default: *]
Wildcard filter for site city name.

| | --country-codes |

[Default: *]
Semicolon-separated list of wildcard filters for site country codes.

| -| --insecure-tls |

[Default: false]
Set to true to skip TLS certificates verification.

| +| --insecure-tls |

[Default: false]
Set to true to skip TLS certificates verification.

| | Command arguments | | | release bundle name | The name of the release bundle. | | release bundle version | The release bundle version. | @@ -258,25 +258,25 @@ This command deletes a Release Bundle from the Edge Nodes and optionally from Di #### Commands Params -| | | -|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------| -| Command-name | release-bundle-delete | -| Abbreviation | rbdel | -| Command options | | -| --server-id |

[Optional]
Artifactory server ID configured using the config command.

| +| | | +|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Command-name | release-bundle-delete | +| Abbreviation | rbdel | +| Command options | | +| --server-id |

[Optional]
Artifactory server ID configured using the config command.

| | --sync |

[Default: false]
Set to true to enable sync deletion (the command execution will end when the deletion process ends).

| -| --max-wait-minutes |

[Default: 60]
Max minutes to wait for sync deletion.

| +| --max-wait-minutes |

[Default: 60]
Max minutes to wait for sync deletion.

| | --dry-run |

[Default: false]
Set to true to disable communication with JFrog Distribution.

| -| --dist-rules |

[Optional]
Path to a file, which includes the distribution rules in a JSON format.

| -| --site |

[Default: *]
Wildcard filter for site name.

| -| --city |

[Default: *]
Wildcard filter for site city name.

| -| --country-codes |

[Default: *]
Semicolon-separated list of wildcard filters for site country codes.

| +| --dist-rules |

[Optional]
Path to a file, which includes the distribution rules in a JSON format.

| +| --site |

[Default: *]
Wildcard filter for site name.

| +| --city |

[Default: *]
Wildcard filter for site city name.

| +| --country-codes |

[Default: *]
Semicolon-separated list of wildcard filters for site country codes.

| | --delete-from-dist |

[Default: false]
Set to true to delete release bundle version in JFrog Distribution itself after deletion is complete in the specified Edge nodes.

| | --quiet |

[Default: false]
Set to true to skip the delete confirmation message.

| | --insecure-tls |

[Default: false]
Set to true to skip TLS certificates verification.

| -| Command arguments | | -| release bundle name | The name of the release bundle. | -| release bundle version | The release bundle version. | +| Command arguments | | +| release bundle name | The name of the release bundle. | +| release bundle version | The release bundle version. | #### Example 1 diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-published-builds.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-published-builds.md index 856db9c..5ce956e 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-published-builds.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-published-builds.md @@ -6,20 +6,20 @@ JFrog CLI is integrated with JFrog Xray and JFrog Artifactory, allowing you to h ### Commands Params -| | | -|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Command name | build-scan | -| Abbreviation | bs | -| Command options | | +| | | +|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Command name | build-scan | +| Abbreviation | bs | +| Command options | | | --server-id |

[Optional]
Server ID configured by the jf c add command. If not specified, the default configured server is used.

| | --vuln |

[Optional]
Set if you'd like to receive all vulnerabilities, regardless of the policy configured in Xray.

| | --fail |

[Default: true]
When set, the command returns exit code 3 if a 'Fail Build' rule is matched by Xray.
Set to false if you do not wish the command to return exit code 3 in such case, and an exit code 0 will be returned.

| | --format |

[Default: table]
Defines the output format of the command. The accepted values are: table and json.

| | --project |

[Optional]
JFrog project key

| | --rescan |

[Default: false]
Set to true when scanning an already successfully scanned build, for example after adding an ignore rule.

| -| Command arguments | The command accepts two arguments. | -| Build name | Build name to be scanned. | -| Build number | Build number to be scanned. | +| Command arguments | The command accepts two arguments. | +| Build name | Build name to be scanned. | +| Build number | Build number to be scanned. | ### Example diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-your-binaries.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-your-binaries.md index eba1007..4563bb2 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-your-binaries.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-your-binaries.md @@ -19,11 +19,11 @@ This _**jf scan**_ command scans files on the local file system with Xray. #### Commands Params -| | | -|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **Command name** | scan | -| **Abbreviation** | s | -| **Command options** | | +| | | +|-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **Command name** | scan | +| **Abbreviation** | s | +| **Command options** | | | --server-id |

[Optional]
Server ID configured using the jf c add command. If not specified, the default configured server is used.

| | --spec |

[Optional]
Path to a file specifying the files to scan. If the pattern argument is provided to the command, this option should not be provided.

| | --project |

[Optional]
JFrog project key, to enable Xray to determine security violations accordingly. The command accepts this option only if the --repo-path and --watches options are not provided. If none of the three options are provided, the command will show all known vulnerabilities.

| @@ -31,8 +31,8 @@ This _**jf scan**_ command scans files on the local file system with Xray. | --watches |

[Optional]
A comma-separated list of Xray watches, to enable Xray to determine violations accordingly. The command accepts this option only if the --project and --repo-path options are not provided. If none of the three options are provided, the command will show all known vulnerabilities.

| | --licenses |

[Default: false]
Set if you also require the list of licenses to be displayed.

| | --format=json |

[Optional]
Produces a JSON file containing the scan results.

| -| **Command arguments** | | -| **Pattern** | Specifies the local file system path to artifacts to be scanned. You can specify multiple files by using wildcards. | +| **Command arguments** | | +| **Pattern** | Specifies the local file system path to artifacts to be scanned. You can specify multiple files by using wildcards. | #### Example 1 @@ -99,19 +99,19 @@ This j\_**f docker scan**\_ command scans docker containers located on the local #### Commands Params -| | | -|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **Command name** | docker scan | -| **Abbreviation** | | -| **Command options** | | +| | | +|-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **Command name** | docker scan | +| **Abbreviation** | | +| **Command options** | | | --server-id |

[Optional]
Server ID configured using the jf c add command. If not specified, the default configured server is used.

| | --project |

[Optional]
JFrog project key, to enable Xray to determine security violations accordingly. The command accepts this option only if the --repo-path and --watches options are not provided. If none of the three options are provided, the command will show all known vulnerabilities.

| | --repo-path |

[Optional]
Artifactory repository path in the form of <repository>/<path in the repository>, to enable Xray to determine violations accordingly. The command accepts this option only if the --project and --watches options are not provided. If none of the three options are provided, the command will show all known vulnerabilities.

| | --watches |

[Optional]
A comma separated list of Xray watches, to enable Xray to determine violations accordingly. The command accepts this option only if the --repo-path and --repo-path options are not provided. If none of the three options are provided, the command will show all known vulnerabilities.

| | --licenses |

[Default: false]
Set if you also require the list of licenses to be displayed.

| | --format=json |

[Optional]
Produces a JSON file containing the scan results.

| -| **Command arguments** | | -| **Pattern** | Specifies the local file system path to artifacts to be scanned. You can specify multiple files by using wildcards. | +| **Command arguments** | | +| **Pattern** | Specifies the local file system path to artifacts to be scanned. You can specify multiple files by using wildcards. | #### Example 1 diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-your-source-code.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-your-source-code.md index e709277..808631d 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-your-source-code.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-your-source-code.md @@ -35,11 +35,11 @@ This command also supports the following Advanced Scans with the **Advanced Secu #### Commands Params -| | | -|-----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **Command name** | audit | -| **Abbreviation** | aud | -| **Command options** | | +| | | +|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **Command name** | audit | +| **Abbreviation** | aud | +| **Command options** | | | --server-id |

[Optional]
Server ID configured using the jf c add command. If not specified, the default configured server is used.

| | --project |

[Optional]
JFrog project key, to enable Xray to determine security violations accordingly. The command accepts this option only if the --repo-path and --watches options are not provided. If none of the three options are provided, the command will show all known vulnerabilities

| | --repo-path |

[Optional]
Artifactory repository path in the form of <repository>/<path in the repository>, to enable Xray to determine violations accordingly. The command accepts this option only if the --project and --watches options are not provided. If none of the three options are provided, the command will show all known vulnerabilities

| @@ -64,7 +64,7 @@ This command also supports the following Advanced Scans with the **Advanced Secu | --pip |

[Default: false]
Set to true to request audit for a Pip project.

| | --pipenv |

[Default: false]
Set to true to request audit for a Pipenv project.

| | --yarn |

[Default: false]
Set to true to request audit for a Yarn project.

| -| **Command arguments** | The command accepts no arguments | +| **Command arguments** | The command accepts no arguments | #### **Output Example** @@ -135,7 +135,7 @@ Execute a cUrl command, using the configured Xray details. The command expects t | Command name | xr curl | | Abbreviation | xr cl | | Command options | | -| --server-id |

[Optional]
Server ID configured using the jf c add command. If not specified, the default configured server is used.

| +| --server-id |

[Optional]
Server ID configured using the jf c add command. 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:

1. The full Xray URL should not be passed. Instead, the REST endpoint URI should be sent.
2. The login credentials should not be passed. Instead, the --server-id should be used.

| diff --git a/jfrog-applications/jfrog-cli/get-started/configurations/jfrog-platform-configuration.md b/jfrog-applications/jfrog-cli/get-started/configurations/jfrog-platform-configuration.md index a8647cc..a91549c 100644 --- a/jfrog-applications/jfrog-cli/get-started/configurations/jfrog-platform-configuration.md +++ b/jfrog-applications/jfrog-cli/get-started/configurations/jfrog-platform-configuration.md @@ -15,7 +15,7 @@ This command allows creating [Access Tokens](https://jfrog.com/help/r/jfrog-plat ### Commands Params | | | -| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Command name | access-token-create | | Abbreviation | atc | | Command arguments | | @@ -54,7 +54,7 @@ jf atc toad The **config add** and **config edit** commands are used to add and edit JFrog Platform server configuration, stored in JFrog CLI's configuration storage. These configured servers can be used by the other commands. The configured servers' details can be overridden per command by passing in alternative values for the URL and login credentials. The values configured are saved in file under the JFrog CLI home directory. | | | -| ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Command Name | config add / config edit | | Abbreviation | c add / c edit | | Command options | | @@ -64,7 +64,7 @@ The **config add** and **config edit** commands are used to add and edit JFrog P | --client-cert-key-path |

[Optional]

Private key file for the client certificate in PEM format.

| | --client-cert-path |

[Optional]

Client certificate file in PEM format.

| | --dist-url |

[Optional]

Distribution URL.

| -| --enc-password |

[Default: true]
If true, the configured password will be encrypted using Artifactory'sencryption API before being stored. If false, the configured password will not be encrypted.

| +| --enc-password |

[Default: true]
If true, the configured password will be encrypted using Artifactory'sencryption API before being stored. If false, the configured password will not be encrypted.

| | --insecure-tls |

[Default: false]

Set to true to skip TLS certificates verification, while encrypting the Artifactory password during the config process.

| | --interactive |

[Default: true, unless $CI is true]

Set to false if you do not want the config command to be interactive.

| | --mission-control-url |

[Optional]

Mission Control URL.

| @@ -74,7 +74,7 @@ The **config add** and **config edit** commands are used to add and edit JFrog P | --url |

[Optional]

JFrog platform URL.

| | --user |

[Optional]

JFrog Platform username.

| | --xray-url | \[Optional] Xray URL. | -| --overwrite |

[Available for config add only]
[Default: false]
Overwrites the instance configuration if an instance with the same ID already exists.

| +| --overwrite |

[Available for config add only]
[Default: false]
Overwrites the instance configuration if an instance with the same ID already exists.

| | Command arguments | | | server ID | A unique ID for the server configuration. | @@ -83,7 +83,7 @@ The **config add** and **config edit** commands are used to add and edit JFrog P The _config remove_ command is used to remove JFrog Platform server configuration, stored in JFrog CLI's configuration storage. | | | -| ----------------- | ------------------------------------------------------------------------------------ | +|-------------------|--------------------------------------------------------------------------------------| | Command name | config remove | | Abbreviation | c rm | | Command options | | @@ -96,7 +96,7 @@ The _config remove_ command is used to remove JFrog Platform server configuratio The _config show_ command shows the stored configuration. You may show a specific server's configuration by sending its ID as an argument to the command. | | | -| ----------------- | --------------------------------------------------------------------------------------- | +|-------------------|-----------------------------------------------------------------------------------------| | Command name | config show | | Abbreviation | c s | | Command arguments | | @@ -107,7 +107,7 @@ The _config show_ command shows the stored configuration. You may show a specifi The _config use_ command sets a configured server as default. The following commands will use this server. | | | -| ----------------- | --------------------------------------- | +|-------------------|-----------------------------------------| | Command name | config use | | Command arguments | | | server ID | The ID of the server to set as default. | @@ -119,7 +119,7 @@ The _config export_ command generates a token, which stores the server configura ### Export | | | -| ----------------- | ------------------------------ | +|-------------------|--------------------------------| | Command name | config export | | Abbreviation | c ex | | Command arguments | | @@ -128,7 +128,7 @@ The _config export_ command generates a token, which stores the server configura ### Import | | | -| ----------------- | ------------------- | +|-------------------|---------------------| | Command name | config import | | Abbreviation | c im | | Command arguments | | diff --git a/jfrog-applications/jfrog-cli/get-started/configurations/proxy-support.md b/jfrog-applications/jfrog-cli/get-started/configurations/proxy-support.md index 069b261..260dfd2 100644 --- a/jfrog-applications/jfrog-cli/get-started/configurations/proxy-support.md +++ b/jfrog-applications/jfrog-cli/get-started/configurations/proxy-support.md @@ -5,7 +5,7 @@ JFrog CLI supports using an HTTP/S proxy. All you need to do is set HTTP\_PROXY HTTP\_PROXY, HTTPS\_PROXY and NO\_PROXY are the industry standards for proxy usages. | Variable Name | Description | -| ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +|---------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | HTTP\_PROXY | Determines a URL to an HTTP proxy. | | HTTPS\_PROXY | Determines a URL to an HTTPS proxy. | | NO\_PROXY | Use this variable to bypass the proxy to IP addresses, subnets or domains. This may contain a comma-separated list of hostnames or IPs without protocols and ports. A typical usage may be to set this variable to Artifactory’s IP address. | diff --git a/jfrog-applications/jfrog-cli/get-started/download-and-install/usage.md b/jfrog-applications/jfrog-cli/get-started/download-and-install/usage.md index 3324351..55bfda2 100644 --- a/jfrog-applications/jfrog-cli/get-started/download-and-install/usage.md +++ b/jfrog-applications/jfrog-cli/get-started/download-and-install/usage.md @@ -11,7 +11,7 @@ The **jf options** command displays all the supported environment variables. JFrog CLI makes use of the following environment variables: | Variable Name | Description | -| ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +|---------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **JFROG\_CLI\_LOG\_LEVEL** |

[Default: INFO]

This variable determines the log level of the JFrog CLI. Possible values are: DEBUG, INFO, WARN and ERROR. If set to ERROR, JFrog CLI logs error messages only. It is useful when you wish to read or parse the JFrog CLI output and do not want any other information logged.

| | **JFROG\_CLI\_LOG\_TIMESTAMP** |

[Default: TIME]

Controls the log messages timestamp format. Possible values are: TIME, DATE_AND_TIME, and OFF.

| | **JFROG\_CLI\_HOME\_DIR** |

[Default: ~/.jfrog]

Defines the JFrog CLI home directory.

| From 92ad007a6167e96328158f488c2e20f2e509c4a2 Mon Sep 17 00:00:00 2001 From: Michael Sverdlov Date: Thu, 18 Apr 2024 13:56:21 +0300 Subject: [PATCH 7/9] fix docs --- .github/workflows/tests.yml | 5 +- jfrog-applications/SUMMARY.md | 3 +- .../pull-request-scan-results.md | 10 +-- .../scan-bitbucket-server-pull-request.md | 2 +- .../scan-github-pull-request.md | 4 +- .../scan-gitlab-pull-request.md | 2 +- .../view-security-alerts-on-github.md | 2 +- .../build-integration.md | 87 +++++++++++++------ .../generic-files.md | 73 ++++++++++++++-- .../jfrog-cli/cli-for-jfrog-curation.md | 6 +- .../cli-for-jfrog-security/README.md | 27 +++++- .../cli-for-jfrog-security/authentication.md | 55 ++++++++++-- .../curl-integration.md | 31 +++++++ .../download-updates-for-xrays-database.md | 55 +++++++++++- .../scan-your-source-code.md | 35 +------- .../jfrog-platform-configuration.md | 1 + 16 files changed, 306 insertions(+), 92 deletions(-) create mode 100644 jfrog-applications/jfrog-cli/cli-for-jfrog-security/curl-integration.md diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 16427c8..034e4c8 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -10,12 +10,13 @@ jobs: - uses: actions/checkout@v4 - name: Install Go - uses: actions/setup-go@v3 + uses: actions/setup-go@v5 with: go-version: 1.21.x + cache: 'false' - name: Go Cache - uses: actions/cache@v3 + uses: actions/cache@v4 with: path: ~/go/pkg/mod key: ubuntu-go-${{ hashFiles('**/go.sum') }} diff --git a/jfrog-applications/SUMMARY.md b/jfrog-applications/SUMMARY.md index d716699..af155f9 100644 --- a/jfrog-applications/SUMMARY.md +++ b/jfrog-applications/SUMMARY.md @@ -30,8 +30,9 @@ * [CLI for JFrog Security](jfrog-cli/cli-for-jfrog-security/README.md) * [Authentication](jfrog-cli/cli-for-jfrog-security/authentication.md) * [Scan your Source Code](jfrog-cli/cli-for-jfrog-security/scan-your-source-code.md) - * [Scan your Binaries](jfrog-cli/cli-for-jfrog-security/scan-your-binaries.md) + * [cUrl Integration](jfrog-cli/cli-for-jfrog-security/curl-integration.md) * [Scan Published Builds](jfrog-cli/cli-for-jfrog-security/scan-published-builds.md) + * [Scan your Binaries](jfrog-cli/cli-for-jfrog-security/scan-your-binaries.md) * [Download Updates for Xray's Database](jfrog-cli/cli-for-jfrog-security/download-updates-for-xrays-database.md) * [CLI for JFrog Curation](jfrog-cli/cli-for-jfrog-curation.md) * [CLI for JFrog Distribution](jfrog-cli/cli-for-jfrog-distribution.md) diff --git a/jfrog-applications/jfrog-applications/frogbot/scan-pull-requests/pull-request-scan-results.md b/jfrog-applications/jfrog-applications/frogbot/scan-pull-requests/pull-request-scan-results.md index 4f855a8..f250e5b 100644 --- a/jfrog-applications/jfrog-applications/frogbot/scan-pull-requests/pull-request-scan-results.md +++ b/jfrog-applications/jfrog-applications/frogbot/scan-pull-requests/pull-request-scan-results.md @@ -20,11 +20,11 @@ If new vulnerabilities are found, Frogbot adds them as a comment on the pull req **VULNERABLE DEPENDENCIES** -| SEVERITY | CONTEXTUAL ANALYSIS | DIRECT DEPENDENCIES | IMPACTED DEPENDENCY | FIXED VERSIONS | -| :---------------------------------------------------------------------------------------------------------------------------------: | :-----------------: | :-----------------: | :-----------------: | :-----------------------: | -|


Critical

| Not Applicable | minimist:1.2.5 | minimist:1.2.5 |

[0.2.4]
[1.2.6]

| -|


High

| Applicable | protobufjs:6.11.2 | protobufjs:6.11.2 | \[6.11.3] | -|


High

| Not Applicable | lodash:4.17.19 | lodash:4.17.19 | \[4.17.21] | +| SEVERITY | CONTEXTUAL ANALYSIS | DIRECT DEPENDENCIES | IMPACTED DEPENDENCY | FIXED VERSIONS | +|:-----------------------------------------------------------------------------------------------------------------------------------:|:-------------------:|:-------------------:|:-------------------:|:-------------------------:| +|


Critical

| Not Applicable | minimist:1.2.5 | minimist:1.2.5 |

[0.2.4]
[1.2.6]

| +|


High

| Applicable | protobufjs:6.11.2 | protobufjs:6.11.2 | \[6.11.3] | +|


High

| Not Applicable | lodash:4.17.19 | lodash:4.17.19 | \[4.17.21] | **Vulnerability Contextual Analysis** diff --git a/jfrog-applications/jfrog-applications/frogbot/scan-pull-requests/scan-bitbucket-server-pull-request.md b/jfrog-applications/jfrog-applications/frogbot/scan-pull-requests/scan-bitbucket-server-pull-request.md index 537b4d2..9f7e52f 100644 --- a/jfrog-applications/jfrog-applications/frogbot/scan-pull-requests/scan-bitbucket-server-pull-request.md +++ b/jfrog-applications/jfrog-applications/frogbot/scan-pull-requests/scan-bitbucket-server-pull-request.md @@ -2,7 +2,7 @@ After you create a new pull request, Frogbot will automatically scan it. -_**NOTE:**_ The scan output will include only new vulnerabilities added by the pull request. Vulnerabilities that aren't new, and existed in the code before the pull request was created, will not be included in the report. In order to include all of the vulnerabilities in the report, including older ones that weren't added by this PR, use the includeAllVulnerabilities parameter in the frogbot-config.yml file. +_**NOTE:**_ The scan output will include only new vulnerabilities added by the pull request. Vulnerabilities that aren't new, and existed in the code before the pull request was created, will not be included in the report. In order to include all the vulnerabilities in the report, including older ones that weren't added by this PR, use the includeAllVulnerabilities parameter in the frogbot-config.yml file. The Frogbot scan on Bitbucket Server workflow: diff --git a/jfrog-applications/jfrog-applications/frogbot/scan-pull-requests/scan-github-pull-request.md b/jfrog-applications/jfrog-applications/frogbot/scan-pull-requests/scan-github-pull-request.md index 09ba8df..88d34d8 100644 --- a/jfrog-applications/jfrog-applications/frogbot/scan-pull-requests/scan-github-pull-request.md +++ b/jfrog-applications/jfrog-applications/frogbot/scan-pull-requests/scan-github-pull-request.md @@ -1,8 +1,8 @@ -# Scan Github Pull Request +# Scan GitHub Pull Request After you create a new pull request, the maintainer of the Git repository can trigger Frogbot to scan the pull request from the pull request UI. -_**NOTE:**_ The scan output will include only new vulnerabilities added by the pull request. Vulnerabilities that aren't new, and existed in the code before the pull request was created, will not be included in the report. In order to include all of the vulnerabilities in the report, including older ones that weren't added by this PR, use the includeAllVulnerabilities parameter in the frogbot-config.yml file. +_**NOTE:**_ The scan output will include only new vulnerabilities added by the pull request. Vulnerabilities that aren't new, and existed in the code before the pull request was created, will not be included in the report. In order to include all the vulnerabilities in the report, including older ones that weren't added by this PR, use the includeAllVulnerabilities parameter in the frogbot-config.yml file. The Frogbot GitHub scan workflow is: diff --git a/jfrog-applications/jfrog-applications/frogbot/scan-pull-requests/scan-gitlab-pull-request.md b/jfrog-applications/jfrog-applications/frogbot/scan-pull-requests/scan-gitlab-pull-request.md index 798bdfb..1ff2c24 100644 --- a/jfrog-applications/jfrog-applications/frogbot/scan-pull-requests/scan-gitlab-pull-request.md +++ b/jfrog-applications/jfrog-applications/frogbot/scan-pull-requests/scan-gitlab-pull-request.md @@ -2,7 +2,7 @@ After you create a new merge request, the maintainer of the Git repository can trigger Frogbot to scan the merge request from the merge request UI. -_**NOTE:**_ The scan output will include only new vulnerabilities added by the merge request. Vulnerabilities that aren't new, and existed in the code before the merge request was created, will not be included in the report. In order to include all of the vulnerabilities in the report, including older ones that weren't added by this merge request, use the includeAllVulnerabilities parameter in the frogbot-config.yml file. +_**NOTE:**_ The scan output will include only new vulnerabilities added by the merge request. Vulnerabilities that aren't new, and existed in the code before the merge request was created, will not be included in the report. In order to include all the vulnerabilities in the report, including older ones that weren't added by this merge request, use the includeAllVulnerabilities parameter in the frogbot-config.yml file. The Frogbot GitLab flow is as follows: diff --git a/jfrog-applications/jfrog-applications/frogbot/scan-repositories/view-security-alerts-on-github.md b/jfrog-applications/jfrog-applications/frogbot/scan-repositories/view-security-alerts-on-github.md index 115597f..83f7f67 100644 --- a/jfrog-applications/jfrog-applications/frogbot/scan-repositories/view-security-alerts-on-github.md +++ b/jfrog-applications/jfrog-applications/frogbot/scan-repositories/view-security-alerts-on-github.md @@ -1,4 +1,4 @@ -# View Security Alerts on Github +# View Security Alerts on GitHub For GitHub repositories, issues that are found during Frogbot's periodic scans are also added to the [Security Alerts](https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository) view in the UI. diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/build-integration.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/build-integration.md index 4c81a7c..34deb9a 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/build-integration.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/build-integration.md @@ -38,6 +38,10 @@ This command is used to collect environment variables and attach them to a build Environment variables are collected using the `build-collect-env` (`bce`) command. +#### Usage + +```jf rt bce ``` + #### Commands Params The following table lists the command arguments and flags: @@ -46,11 +50,11 @@ 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. | +| Command options | | +| --project |

[Optional]
JFrog project key.

| #### Examples ##### Example 1 @@ -73,6 +77,10 @@ jf rt bce frogger-build 17 The `build-add-git` (bag) command collects the Git revision and 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. +#### Usage + +```jf rt bag [command options] [Path To .git]``` + #### Commands Params The following table lists the command arguments and flags: @@ -81,14 +89,14 @@ 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 the 'jf config' command. This is the server to which the build-info will be later published, using the jf rt build-publish command. This option, if provided, overrides the serverID value in this command's yaml configuration. If both values are not provided, the default server, configured by the 'jf config' command, is used.

| -| --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. | +| 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 the 'jf config' command. This is the server to which the build-info will be later published, using the jf rt build-publish command. This option, if provided, overrides the serverID value in this command's yaml configuration. If both values are not provided, the default server, configured by the 'jf config' command, is used.

| +| --project |

[Optional]
JFrog project key.

| #### Configuration file properties @@ -136,12 +144,21 @@ The download command, as well as other commands which download dependencies from 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-rt** option to the command. +#### Usage + +```jf rt bad [command options] ``` +```jf rt bad --spec= [command options] ``` + #### Commands Params | | | |-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Command name | rt build-add-dependencies | | Abbreviation | rt bad | +| Command arguments | The command takes three 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. | | 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.

| @@ -152,10 +169,6 @@ By default, the command collects the files from the local file system. If you'd | --dry-run |

[Default: false]
Set to true to only get a summery of the dependencies that will be added to the build info.

| | --module |

[Optional]
Optional module name in the build-info for adding the dependency.

| | --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 three 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. | #### Examples ##### Example 1 @@ -187,9 +200,10 @@ jf rt bad my-build-name 7 "path/to/build/dependencies/dir/" --module m1 This command is used to publish build info to Artifactory. To publish the accumulated build-info for a build to Artifactory, use the **build-publish** command. For example, the following command publishes all the build-info collected for build **my-build-name** with build number 18: -``` -jf rt bp my-build-name 18 -``` +### Usage + +```jf rt bp [command options] ``` + ### Commands Params @@ -197,6 +211,9 @@ jf rt bp my-build-name 18 |-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Command name | rt build-publish | | Abbreviation | rt bp | +| Command arguments | The command accepts two arguments. | +| Build name | Build name to be published. | +| Build number | Build number to be published. | | 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.

| @@ -204,10 +221,7 @@ jf rt bp my-build-name 18 | --env-include |

[Default: *]
List 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*]
List 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. | +| --insecure-tls |

[Default: false]
Set to true to skip TLS certificates verification.

| | ### Example @@ -253,16 +267,23 @@ The way to do this is by using the **build-append** command. Running this comman 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, +### Usage + +```jf rt ba ``` + +### Commands Params + | | | |------------------------|-----------------------------------------------------------| | 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 | +| Command options | This command has no options. | + **Requirements** @@ -296,12 +317,20 @@ jf rt download --build aggregating-build/10 This command is used to [promote build](https://jfrog.com/knowledge-base/how-does-build-promotion-work/) in Artifactory. +### Usage + +```jf rt bpr [command options] ``` + ### Commands Params | | | |------------------------|---------------------------------------------------------------------------------------------------------------------------------------------| | Command name | rt build-promote | | Abbreviation | rt bpr | +| 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. | | 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.

| @@ -312,11 +341,7 @@ This command is used to [promote build](https://jfrog.com/knowledge-base/how-doe | --copy |

[Default: false]
If set true, the build artifacts and dependencies are copied to the target repository, otherwise they are moved.

| | --props |

[Optional]
List 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. | +| --insecure-tls |

[Default: false]
Set to true to skip TLS certificates verification.

| | ### Example @@ -330,6 +355,10 @@ jf rt bpr my-build-name 18 target-repository 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 the `build-clean` (`bc`) command. +### Usage + +```jf rt bc ``` + ### Commands Params The following table lists the command arguments and flags: @@ -338,10 +367,10 @@ 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. | +| Command options | The command has no options. | ### Example @@ -356,6 +385,10 @@ jf rt bc my-build-name 18 This command is used to discard builds previously published to Artifactory using the [build-publish](https://docs.jfrog-applications.jfrog.io/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory#publishing-build-info) command. +### Usage + +```jf rt bdi [command options] ``` + ### Commands Params The following table lists the command arguments and flags: @@ -364,6 +397,8 @@ The following table lists the command arguments and flags: |--------------------|------------------------------------------------------------------------------------------------------------------------------------------| | Command name | rt build-discard | | Abbreviation | rt bdi | +| Command arguments | The command accepts one argument. | +| Build name | Build name. | | Command options | | | --server-id |

[Optional]
Server 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.

| @@ -371,9 +406,7 @@ The following table lists the command arguments and flags: | --exclude-builds |

[Optional]
List 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. | - + | ### Examples #### Example 1 diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/generic-files.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/generic-files.md index c885e15..cbca0a0 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/generic-files.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/generic-files.md @@ -470,7 +470,7 @@ This command is used for setting properties on existing files in Artifactory. | Abbreviation | rt sp | | Command arguments |

The command takes two arguments, files pattern and files properties.

In case the --spec option is used, the commands accept no 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. | +| Files properties | A list of Semicolon-separated key-values in the form of key1=value1;key2=value2,..., to be set on the matching files. | | 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 to Using File Specs.

| @@ -510,13 +510,37 @@ The command will set the property "a" with "1" value and the property "b" with t jf rt sp "a=1;b=2,3" --spec my-spec ``` +#### Example 3 + +Set the properties on all the jar files in the maven-local repository. The command will set the property "version" with "1.0.0" value and the property "release" with "stable" value. + +``` +jf rt sp "maven-local/*.jar" "version=1.0.0;release=stable" +``` + +#### Example 4 + +The command will set the property "environment" with "production" value and the property "team" with "devops" value on all files found by the File Spec prod-spec. + +``` +jf rt sp "environment=production;team=devops" --spec prod-spec +``` + +#### Example 5 + +Set the properties on all the tar.gz files in the devops-local repository. The command will set the property "build" with "102" value and the property "branch" with "main" value. + +``` +jf rt sp "devops-local/*.tar.gz" "build=102;branch=main" +``` + ## Deleting Properties from Files This command is used for deleting properties from existing files in Artifactory. ### Usage -```jf rt delp [command options] ``` +```jf rt delp [command options] ``` ```jf rt delp --spec= [command options]``` ### Commands Params @@ -526,8 +550,8 @@ This command is used for deleting properties from existing files in Artifactory. | Command name | rt delete-props | | Abbreviation | rt delp | | Command arguments |

The command takes two arguments, files pattern and files properties.

In case the --spec option is used, the commands accept no 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. | +| Files pattern | Specifies the files pattern in the following format: `[repository name]/[repository path].` You can use wildcards to specify multiple repositories and files. | +| Properties list | A comma-separated list of properties, in the form of key1,key2,..., to be deleted from the matching files. | | 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]
List of properties in the form of "key1=value1;key2=value2,...". Only files with these properties are affected.

| @@ -547,10 +571,45 @@ This command is used for deleting properties from existing files in Artifactory. | --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

| -### Example -Delete the "status" and "phase" properties from all the zip files in the generic-local repository. +### Examples + +#### Example 1 +Remove the properties 'version' and 'release' from all the jar files in the maven-local repository. + +``` +jf rt delp "maven-local/*.jar" "version,release" ``` -jf rt delp "generic-local/*.zip" "status,phase" + +#### Example 2 + +Delete the properties 'build' and 'branch' from all tar.gz files in the devops-local repo. + +``` +jf rt delp "devops-local/*.tar.gz" "build,branch" +``` + +#### Example 3 + +Remove the properties 'status', 'phase' and 'stage' from all deb files that start with DEV in the debian-repository. + +``` +jf rt delp "debian-repository/DEV*.deb" "status,phase,stage" +``` + +#### Example 4 + +Delete the 'environment' property from '/tests/local/block.rpm' in the centos-repo. + +``` +jf rt delp "centos-repo/tests/local/block.rpm" "environment" +``` + +#### Example 5 + +Remove the properties 'component', 'layer' and 'level' from files in the docker-hub repository. + ``` +jf rt delp "docker-hub/*" "component,layer,level" +``` \ No newline at end of file diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-curation.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-curation.md index 19f2975..1a13e95 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-curation.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-curation.md @@ -47,7 +47,7 @@ Before running the command, do the following: #### Example 1 -Audit the project in the current directory. Displays all known packages that were blocked by Curation Policies. +Curation-Audit the project in the current directory. Displays all known packages that were blocked by Curation Policies. ``` jf curation-audit @@ -55,7 +55,7 @@ jf curation-audit #### Example 2 -Audit the projects according to the specific paths defined in the "working-dirs" option. Displays all known packages that were blocked by Curation Policies for all projects. The data is displayed in separate tables. +Curation-Audit the projects according to the specific paths defined in the "working-dirs" option. Displays all known packages that were blocked by Curation Policies for all projects. The data is displayed in separate tables. ``` jf curation-audit --working-dirs="/path/to/project/npm_project1,/path/to/project/npm_project2" @@ -63,7 +63,7 @@ jf curation-audit --working-dirs="/path/to/project/npm_project1,/path/to/project #### Example 3 -Audit the project in the current directory using 5 threads to check the packages Curation status in parallel. Displays all known packages blocked by Curation Policies. +Curation-Audit the project in the current directory using 5 threads to check the packages Curation status in parallel. Displays all known packages blocked by Curation Policies. ``` jf curation-audit --threads=5 diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-security/README.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-security/README.md index 210fd4e..08b46ec 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-security/README.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-security/README.md @@ -8,7 +8,32 @@ When used with Xray, JFrog CLI offers several means of authentication: JFrog CLI To authenticate yourself using your Xray login credentials, either configure your credentials once using the\_jf c add\_command or provide the following option to each command. -
Command optionDescription
--urlJFrog Xray API endpoint URL. It usually ends with /xray
--userJFrog username
--passwordJFrog password
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Command optionDescription
--urlJFrog Xray API endpoint URL. It usually ends with /xray
--userJFrog username
--passwordJFrog password
#### Authenticating with an Access Token diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-security/authentication.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-security/authentication.md index d798663..8a1a3e7 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-security/authentication.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-security/authentication.md @@ -1,18 +1,59 @@ # Authentication -When used with Xray, JFrog CLI offers several means of authentication: JFrog CLI does not support accessing Xray without authentication. +When used with Xray, JFrog CLI offers several means of authentication: JFrog CLI does not support accessing Xray without +authentication. #### Authenticating with Username and Password -To authenticate yourself using your Xray login credentials, either configure your credentials once using the _**jf c add**_ command or provide the following option to each command. - -
Command OptionDescription
--urlJFrog Xray API endpoint URL. It usually ends with /xray
--userJFrog username
--passwordJFrog password
+To authenticate yourself using your Xray login credentials, either configure your credentials once using the +_**jf c add**_ command or provide the following option to each command. + + + + + + + + + + + + + + + + + + + + + + +
Command OptionDescription
--urlJFrog Xray API endpoint URL. It usually ends with /xray
--userJFrog username
--passwordJFrog password
#### Authenticating with an Access Token -To authenticate yourself using an Xray Access Token, either configure your Access Token once using the _**jf c add**_ command or provide the following option to each command. - -
Command OptionDescription
--urlJFrog Xray API endpoint URL. It usually ends with /xray
--access-tokenJFrog access token
+To authenticate yourself using an Xray Access Token, either configure your Access Token once using the _**jf c add**_ +command or provide the following option to each command. + + + + + + + + + + + + + + + + + + +
Command OptionDescription
--urlJFrog Xray API endpoint URL. It usually ends with /xray
--access-tokenJFrog access token
*** diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-security/curl-integration.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-security/curl-integration.md new file mode 100644 index 0000000..7d4f876 --- /dev/null +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-security/curl-integration.md @@ -0,0 +1,31 @@ +# cUrl Integration +### Running cUrl + +Execute a cUrl command, using the configured Xray details. The command expects the cUrl client to be included in the PATH. + +#### Commands Params + +| | | +|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Command name | xr curl | +| Abbreviation | xr cl | +| Command options | | +| --server-id |

[Optional]
Server ID configured using the jf c add command. 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:

1. The full Xray URL should not be passed. Instead, the REST endpoint URI should be sent.
2. The login credentials should not be passed. Instead, the --server-id should be used.

| + +#### Example 1 + +Execute the cUrl client, to send a GET request to the /api/system/version endpoint to the default configured Xray server. + +``` +jf xr curl -XGET /api/v1/system/version +``` + +#### Example 2 + +Execute the cUrl client, to send a GET request to the /api/v1/system/version endpoint to the configured my-xr-server server ID. + +``` +jf rt curl -XGET /api/v1/system/version --server-id my-xr-server +``` diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-security/download-updates-for-xrays-database.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-security/download-updates-for-xrays-database.md index 73f5515..2fffaf3 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-security/download-updates-for-xrays-database.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-security/download-updates-for-xrays-database.md @@ -2,4 +2,57 @@ The offline-update command downloads updates to Xray's vulnerabilities database. The Xray UI allows building the command structure for you. -
Command namexr offline-update
Abbreviationxr ou
Command options
--license-id[Mandatory]
Xray license ID.
--from[Optional]
From update date in YYYY-MM-DD format.
--to[Optional]
To update date in YYYY-MM-DD format.
--version[Optional]
Xray API version.
--target[Default: ./]
Path for downloaded update files.
--dbsyncv3[Default: false]
Set to true to use Xray DBSync V3.
--periodic[Default: false]
Set to true to get the Xray DBSync V3 Periodic Package (Use with dbsyncv3 flag).
Command argumentsThe command accepts no arguments.
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Command namexr offline-update
Abbreviationxr ou
Command options
--license-id[Mandatory]
Xray license ID.
--from[Optional]
From update date in YYYY-MM-DD format.
--to[Optional]
To update date in YYYY-MM-DD format.
--version[Optional]
Xray API version.
--target[Default: ./]
Path for downloaded update files.
--dbsyncv3[Default: false]
Set to true to use Xray DBSync V3.
--periodic[Default: false]
Set to true to get the Xray DBSync V3 Periodic Package (Use with dbsyncv3 flag).
Command argumentsThe command accepts no arguments.
\ No newline at end of file diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-your-source-code.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-your-source-code.md index 808631d..5b9c321 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-your-source-code.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-your-source-code.md @@ -1,4 +1,4 @@ -# Scan your Source Code +# Audit your Source Code The _**jf audit**_ command allows scanning your source code dependencies to find security vulnerabilities and licenses violations, with the ability to scan against your Xray policies. The command builds a deep dependencies graph for your project, scans it with Xray, and displays the results. It uses the package manager used by the project to build the dependencies graph. Currently, the following package managers are supported. @@ -122,35 +122,4 @@ Audit the project in the current directory, excluding all files inside the _node ``` jf audit --exclusions "*node_modules*;*to_exclude" -``` - -### Running cUrl - -Execute a cUrl command, using the configured Xray details. The command expects the cUrl client to be included in the PATH. - -#### Commands Params - -| | | -|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Command name | xr curl | -| Abbreviation | xr cl | -| Command options | | -| --server-id |

[Optional]
Server ID configured using the jf c add command. 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:

1. The full Xray URL should not be passed. Instead, the REST endpoint URI should be sent.
2. The login credentials should not be passed. Instead, the --server-id should be used.

| - -#### Example 1 - -Execute the cUrl client, to send a GET request to the /api/system/version endpoint to the default configured Xray server. - -``` -jf xr curl -XGET /api/v1/system/version -``` - -#### Example 2 - -Execute the cUrl client, to send a GET request to the /api/v1/system/version endpoint to the configured my-xr-server server ID. - -``` -jf rt curl -XGET /api/v1/system/version --server-id my-xr-server -``` +``` \ No newline at end of file diff --git a/jfrog-applications/jfrog-cli/get-started/configurations/jfrog-platform-configuration.md b/jfrog-applications/jfrog-cli/get-started/configurations/jfrog-platform-configuration.md index a91549c..a2e5aac 100644 --- a/jfrog-applications/jfrog-cli/get-started/configurations/jfrog-platform-configuration.md +++ b/jfrog-applications/jfrog-cli/get-started/configurations/jfrog-platform-configuration.md @@ -91,6 +91,7 @@ The _config remove_ command is used to remove JFrog Platform server configuratio | Command arguments | | | server ID | The server ID to remove. If no argument is sent, all configured servers are removed. | + ## Showing the Configured Servers The _config show_ command shows the stored configuration. You may show a specific server's configuration by sending its ID as an argument to the command. From 88620fcd463e7d8111bdbc928a41f20598a88c8e Mon Sep 17 00:00:00 2001 From: Michael Sverdlov Date: Thu, 18 Apr 2024 18:44:26 +0300 Subject: [PATCH 8/9] fix docs --- jfrog-applications/SUMMARY.md | 1 - .../build-integration.md | 62 ++++----- .../environment-variables.md | 2 +- .../generic-files.md | 62 ++++----- .../managing-configuration-entities.md | 65 ++++----- .../release-lifecycle-management.md | 128 ++++++++++-------- .../jfrog-cli/cli-for-jfrog-distribution.md | 2 +- .../scan-your-source-code.md | 2 +- .../setting-up-a-ci-pipeline.md | 27 ---- 9 files changed, 166 insertions(+), 185 deletions(-) delete mode 100644 jfrog-applications/jfrog-cli/get-started/configurations/setting-up-a-ci-pipeline.md diff --git a/jfrog-applications/SUMMARY.md b/jfrog-applications/SUMMARY.md index af155f9..9ebec77 100644 --- a/jfrog-applications/SUMMARY.md +++ b/jfrog-applications/SUMMARY.md @@ -10,7 +10,6 @@ * [Usage](jfrog-cli/get-started/download-and-install/usage.md) * [Configurations](jfrog-cli/get-started/configurations/README.md) * [JFrog Platform Configuration](jfrog-cli/get-started/configurations/jfrog-platform-configuration.md) - * [Setting up a CI Pipeline](jfrog-cli/get-started/configurations/setting-up-a-ci-pipeline.md) * [Proxy Support](jfrog-cli/get-started/configurations/proxy-support.md) * [CLI for JFrog Artifactory](jfrog-cli/cli-for-jfrog-artifactory/README.md) * [Environment Variables](jfrog-cli/cli-for-jfrog-artifactory/environment-variables.md) diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/build-integration.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/build-integration.md index 34deb9a..678071b 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/build-integration.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/build-integration.md @@ -163,7 +163,7 @@ By default, the command collects the files from the local file system. If you'd | --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]
List 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}.

| +| --spec-vars |

[Optional]
List of Semicolon-separated 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.

| @@ -207,21 +207,21 @@ For example, the following command publishes all the build-info collected for bu ### Commands Params -| | | -|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Command name | rt build-publish | -| Abbreviation | rt bp | -| Command arguments | The command accepts two arguments. | -| Build name | Build name to be published. | -| Build number | Build number to be published. | -| 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: *]
List 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*]
List 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 name | rt build-publish | +| Abbreviation | rt bp | +| Command arguments | The command accepts two arguments. | +| Build name | Build name to be published. | +| Build number | Build number to be published. | +| 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: *]
List of Semicolon-separated 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*]
List of Semicolon-separated 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.

| | ### Example @@ -339,7 +339,7 @@ This command is used to [promote build](https://jfrog.com/knowledge-base/how-doe | --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]
List of properties in the form of "key1=value1;key2=value2,...". to attach to the build artifacts.

| +| --props |

[Optional]
List of Semicolon-separated 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.

| | @@ -393,20 +393,20 @@ This command is used to discard builds previously published to Artifactory using The following table lists the command arguments and flags: -| | | -|--------------------|------------------------------------------------------------------------------------------------------------------------------------------| -| Command name | rt build-discard | -| Abbreviation | rt bdi | -| Command arguments | The command accepts one argument. | -| Build name | Build name. | -| Command options | | -| --server-id |

[Optional]
Server 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]
List 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 name | rt build-discard | +| Abbreviation | rt bdi | +| Command arguments | The command accepts one argument. | +| Build name | Build name. | +| Command options | | +| --server-id |

[Optional]
Server 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]
List of comma-separated build numbers in the form of "build1,build2,...", 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.

| + ### Examples #### Example 1 diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/environment-variables.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/environment-variables.md index cc8d133..17b68d9 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/environment-variables.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/environment-variables.md @@ -15,7 +15,7 @@ Some of the Artifactory commands make use of the following environment variable: | **JFROG\_CLI\_BUILD\_NUMBER** | Build number to be used by commands which expect a build number, unless sent as a command argument or option. | | **JFROG\_CLI\_BUILD\_PROJECT** | JFrog project key to be used by commands that expect build name and build number. Determines the project of the published build. | | **JFROG\_CLI\_BUILD\_URL** | Sets the CI server build URL in the build-info. The "jf rt build-publish" command uses the value of this environment variable unless the --build-url command option is sent. | -| **JFROG\_CLI\_ENV\_EXCLUDE** |

[Default: *password*;*secret*;*key*;*token*]
List of case insensitive patterns in the form of "value1;value2;...". Environment variables match those patterns will be excluded. This environment variable is used by the "jf rt build-publish" command, in case the --env-exclude command option is not sent.

| +| **JFROG\_CLI\_ENV\_EXCLUDE** |

[Default: *password*;*secret*;*key*;*token*]
List of Semicolon-separated case insensitive patterns in the form of "value1;value2;...". Environment variables match those patterns will be excluded. This environment variable is used by the "jf rt build-publish" command, in case the --env-exclude command option is not sent.

| | **JFROG\_CLI\_TRANSITIVE\_DOWNLOAD\_EXPERIMENTAL** |

[Default: false]
Used by the "jf rt download" command. Set to true to download artifacts also from remote repositories. This feature is experimental and available on Artifactory version 7.17.0 or higher.

| | **JFROG\_CLI\_UPLOAD\_EMPTY\_ARCHIVE** |

[Default: false]
Used by the "jf rt upload" command. Set to true if you'd like to upload an empty archive when '--archive' is set but all files were excluded by exclusions pattern.

| diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/generic-files.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/generic-files.md index cbca0a0..ef81d76 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/generic-files.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/generic-files.md @@ -22,7 +22,7 @@ This command is used to upload files to Artifactory. | --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 the jf c add command. If not specified, the default configured Artifactory server is used.

| | --spec |

[Optional]
Path to a file spec. For more details, please refer to Using File Specs.

| -| --spec-vars |

[Optional]
List 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}.

| +| --spec-vars |

[Optional]
List of Semicolon-separated 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 to Build Integration.

| | --build-number |

[Optional]
Build number. For more details, please refer to Build Integration.

| | --project |

[Optional]
JFrog project key.

| @@ -135,7 +135,7 @@ This command is used to download files from Artifactory. | --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 to Using File Specs.

| -| --spec-vars |

[Optional]
List 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}.

| +| --spec-vars |

[Optional]
List of Semicolon-separated 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 Artifactory properties specified as "key=value" pairs separated by a semi-colon (for example, "key1=value1;key2=value2;key3=value3"). Only artifacts with all of the specified properties names and values will be downloaded.

| | --exclude-props |

[Optional]
A list of Artifactory properties specified as "key=value" pairs separated by a semi-colon (for example, "key1=value1;key2=value2;key3=value3"). Only artifacts without all of 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.

| @@ -409,7 +409,7 @@ This command is used to search and display files in Artifactory. | --spec |

[Optional]
Path to a file spec. For more details, please refer to Using File Specs.

| | --count |

[Optional]
Set to true to display only the total of files or folders found.

| | --include-dirs |

[Default: false]
Set to true if you'd like to also apply the source path pattern for directories and not only for files

| -| --spec-vars |

[Optional]
List 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}.

| +| --spec-vars |

[Optional]
List of Semicolon-separated 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 Artifactory properties specified as "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 Artifactory properties specified as "key=value" pairs separated by a semi-colon (for example, "key1=value1;key2=value2;key3=value3"). Only artifacts without all of 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.

| @@ -426,7 +426,7 @@ This command is used to search and display files in Artifactory. | --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

| -| --include |

[Optional]
List of fields in the form of "value1;value2;...".
Only the path and the fields that are specified will be returned. The fields must be part of the 'items' AQL domain. for the full supported items list check AQL documentation

| +| --include |

[Optional]
List of Semicolon-separated fields in the form of "value1;value2;...".
Only the path and the fields that are specified will be returned. The fields must be part of the 'items' AQL domain. for the full supported items list check AQL documentation

| ### Examples #### Example 1 @@ -474,8 +474,8 @@ This command is used for setting properties on existing files in Artifactory. | 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 to Using File Specs.

| -| --spec-vars |

[Optional]
List 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]
List of properties in the form of "key1=value1;key2=value2,...". Only files with these properties names and values are affected.

| +| --spec-vars |

[Optional]
List of Semicolon-separated 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]
List of Semicolon-separated 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 Artifactory properties specified as "key=value" pairs separated by a semi-colon (for example, "key1=value1;key2=value2;key3=value3"). Only artifacts without all of 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.

| @@ -545,31 +545,31 @@ This command is used for deleting properties from existing files in Artifactory. ### Commands Params -| | | -|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Command name | rt delete-props | -| Abbreviation | rt delp | -| Command arguments |

The command takes two arguments, files pattern and files properties.

In case the --spec option is used, the commands accept no arguments.

| -| Files pattern | Specifies the files pattern in the following format: `[repository name]/[repository path].` You can use wildcards to specify multiple repositories and files. | -| Properties list | A comma-separated list of properties, in the form of key1,key2,..., to be deleted from the matching files. | -| 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]
List of properties in the form of "key1=value1;key2=value2,...". Only files with these properties are affected.

| -| --exclude-props |

[Optional]
A list of Artifactory properties specified as "key=value" pairs separated by a semi-colon (for example, "key1=value1;key2=value2;key3=value3"). Only artifacts without all of 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]
A list of semicolon-separated fields to sort by. The fields must be part of the 'items' AQL domain. For more information read the AQL 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.

| -| --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 name | rt delete-props | +| Abbreviation | rt delp | +| Command arguments |

The command takes two arguments, files pattern and properties list.

In case the --spec option is used, the commands accept no arguments.

| +| Files pattern | Specifies the files pattern in the following format: `[repository name]/[repository path].` You can use wildcards to specify multiple repositories and files. | +| Properties list | A comma-separated list of properties, in the form of key1,key2,..., to be deleted from the matching files. | +| 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]
List of Semicolon-separated properties in the form of "key1=value1;key2=value2,...". Only files with these properties are affected.

| +| --exclude-props |

[Optional]
List of Semicolon-separated Artifactory properties specified as "key=value" (for example, "key1=value1;key2=value2;key3=value3"). Only artifacts without all of 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 | List of Semicolon-separated exclude patterns. Allows using wildcards. | +| --sort-by |

[Optional]
A list of semicolon-separated fields to sort by. The fields must be part of the 'items' AQL domain. For more information read the AQL 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.

| +| --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

| ### Examples diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/managing-configuration-entities.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/managing-configuration-entities.md index ecc01a8..23d25ac 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/managing-configuration-entities.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/managing-configuration-entities.md @@ -198,15 +198,15 @@ These two commands create a new repository and updates an existing a repository. #### Commands Params -| | | -|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| 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]
List 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. | +| | | +|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 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]
List of Semicolon-separated 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. | #### Examples ##### Example 1 @@ -302,15 +302,15 @@ This command creates a new replication job for a repository. The command accepts #### Commands Params -| | | -|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Command-name | replication-create | -| Abbreviation | rt rplc | -| Command options | | -| --server-id |

[Optional]
Artifactory server ID configured using the config command.

| -| --vars |

[Optional]
List 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. | +| | | +|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Command-name | replication-create | +| Abbreviation | rt rplc | +| Command options | | +| --server-id |

[Optional]
Artifactory server ID configured using the config command.

| +| --vars |

[Optional]
List of Semicolon-separated 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. | #### Examples ##### Example 1 @@ -373,24 +373,17 @@ This command creates a configuration template file, which will be used as an arg These commands create/update a permission target. The commands accept as an argument a configuration template, which should be created by the **jf rt permission-target-template** command beforehand. 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]
List 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. | -| | | -|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| 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]
List 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 should be created using the "jf rt ptt" command. | +| | | +|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Command-name | permission-target-create / permission-target-update | +| Abbreviation | rt ptc / rt ptu | +| 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. | +| 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]
List of Semicolon-separated 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}.

| ### Deleting Permission Targets diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/release-lifecycle-management.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/release-lifecycle-management.md index 106fe21..614356a 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/release-lifecycle-management.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/release-lifecycle-management.md @@ -94,20 +94,20 @@ The file spec may be of one of the following creation sources: ### Commands Params -| | | -|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Command-name | release-bundle-create | -| Abbreviation | rbc | -| Command options | | -| --project |

[Optional]
Project key associated with the created Release Bundle version.

| -| --server-id |

[Optional]
Platform server ID configured using the config command.

| -| --signing-key |

[Mandatory]
The GPG/RSA key-pair name given in Artifactory.

| -| --spec |

[Optional]
Path to a File Spec.

| -| --spec-vars |

[Optional]
List of variables in the form of "key1=value1;key2=value2;..." (wrapped by quotes) to be replaced in the File Spec. In the File Spec, the variables should be used as follows: ${key1}.

| -| --sync |

[Default: false]
Set to true to run synchronously.

| -| Command arguments | | -| release bundle name | Name of the newly created Release Bundle. | -| release bundle version | Version of the newly created Release Bundle. | +| | | +|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Command-name | release-bundle-create | +| Abbreviation | rbc | +| Command options | | +| --project |

[Optional]
Project key associated with the created Release Bundle version.

| +| --server-id |

[Optional]
Platform server ID configured using the config command.

| +| --signing-key |

[Mandatory]
The GPG/RSA key-pair name given in Artifactory.

| +| --spec |

[Optional]
Path to a File Spec.

| +| --spec-vars |

[Optional]
List of Semicolon-separated variables in the form of "key1=value1;key2=value2;..." (wrapped by quotes) to be replaced in the File Spec. In the File Spec, the variables should be used as follows: ${key1}.

| +| --sync |

[Default: false]
Set to true to run synchronously.

| +| Command arguments | | +| release bundle name | Name of the newly created Release Bundle. | +| release bundle version | Version of the newly created Release Bundle. | ### Examples #### Example 1 @@ -247,21 +247,25 @@ The Distribution Rules format also supports wildcards. For example: ### Examples #### Example 1 Distribute the release bundle named myApp with version 1.0.0. Use the distribution rules defined in the specified file. - - jf rbd --dist-rules=/path/to/dist-rules.json myApp 1.0.0 +``` +jf rbd --dist-rules=/path/to/dist-rules.json myApp 1.0.0 +``` #### Example 2 Distribute the release bundle named myApp with version 1.0.0 using the default distribution rules. Map files under the 'source' directory to be placed under the 'target' directory. - jf rbd --dist-rules=/path/to/dist-rules.json --mapping-pattern="(*)/source/(*)" --mapping-target="{1}/target/{2}" myApp 1.0.0 +``` +jf rbd --dist-rules=/path/to/dist-rules.json --mapping-pattern="(*)/source/(*)" --mapping-target="{1}/target/{2}" myApp 1.0.0 +``` #### Example 3 -Synchronously distribute a release bundle associated with project "proj" - - jf rbd --dist-rules=/path/to/dist-rules.json --sync --project="proj" myApp 1.0.0 +Synchronously distribute a release bundle associated with project "proj" +``` +jf rbd --dist-rules=/path/to/dist-rules.json --sync --project="proj" myApp 1.0.0 +``` ## Deleting release bundle locally This command allows deleting all release bundle promotions to an environment or deleting a release bundle locally altogether. @@ -285,18 +289,23 @@ Deleting locally means distributions of the release bundle will not be deleted. #### Example 1 Locally delete the release bundle named myApp with version 1.0.0 altogether. - jf rbdell myApp 1.0.0 +``` +jf rbdell myApp 1.0.0 +``` #### Example 2 Delete a release bundle locally altogether. Run the command synchronously and skip the confirmation message. - jf rbdell --quiet --sync myApp 1.0.0 +``` +jf rbdell --quiet --sync myApp 1.0.0 +``` #### Example 3 Delete all promotions of the release bundle to environment "PROD". - jf rbdell myApp 1.0.0 PROD - +``` +jf rbdell myApp 1.0.0 PROD +``` ## Deleting release bundle remotely This command will delete distributions of a release bundle from edge nodes. @@ -324,65 +333,72 @@ This command will delete distributions of a release bundle from edge nodes. #### Example 1 Delete the distributions of release bundle named myApp with version 1.0.0 from edge nodes matching the provided distribution rules defined in the specified file. - jf rbd --dist-rules=/path/to/dist-rules.json myApp 1.0.0 +``` +jf rbd --dist-rules=/path/to/dist-rules.json myApp 1.0.0 +``` #### Example 2 Delete the distributions of the release bundle associated with project "proj" from the provided edge nodes. Run the command synchronously and skip the confirmation message. - jf rbd --dist-rules=/path/to/dist-rules.json --project="proj" --quiet --sync myApp 1.0.0 +``` +jf rbd --dist-rules=/path/to/dist-rules.json --project="proj" --quiet --sync myApp 1.0.0 +``` ## Exporting Release Bundle archive JFrog Lifecycle Management supports distributing your Release Bundles to remote Edge nodes within an air-gapped environment. This use case is mainly intended for organizations that have two or more JFrog instances that have no network connection between them. The following command allows exporting a Release Bundle as an archive to the filesystem that can be transferred to a different instance in an air-gapped environment. - -| | | -|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------| -| Command-name | release-bundle-export | -| Abbreviation | rbe | -| Command arguments | | -| release bundle name | Name of the Release Bundle to export. | -| release bundle version | Version of the release bundle to export. -| target pattern | The 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". -| Command options | | -| --project |

[Optional]

Project key associated with the Release Bundle version.

| -| --server-id |

[Optional]

Platform server ID configured using the config command.

| -| mapping-pattern |

[Optional]

Specify a list of input regex mapping pairs that define where the queried artifact is located and where it should be placed after it is imported. Use this option if the path on the target is different than the source path. -| mapping-target |

[Optional]

Specify a list of output regex mapping pairs that define where the queried artifact is located and where it should be placed after it is imported. Use this option if the path on the target is different than the source path. -| split-count |

[Optional]

The maximum number of parts that can be concurrently uploaded per file during a multi-part upload. Set to 0 to disable multi-part upload. -| min-split |

[Optional]

Minimum file size in KB to split into ranges when downloading. Set to -1 for no splits +| | | +|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Command-name | release-bundle-export | +| Abbreviation | rbe | +| Command arguments | | +| release bundle name | Name of the Release Bundle to export. | +| release bundle version | Version of the release bundle to export. | +| target pattern | The 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". | +| Command options | | +| --project |

[Optional]
Project key associated with the Release Bundle version.

| +| --server-id |

[Optional]
Platform server ID configured using the config command.

| +| mapping-pattern |

[Optional]
Specify a list of input regex mapping pairs that define where the queried artifact is located and where it should be placed after it is imported. Use this option if the path on the target is different than the source path. | +| mapping-target |

[Optional]
Specify a list of output regex mapping pairs that define where the queried artifact is located and where it should be placed after it is imported. Use this option if the path on the target is different than the source path. | +| split-count |

[Optional]
The maximum number of parts that can be concurrently uploaded per file during a multi-part upload. Set to 0 to disable multi-part upload. | +| min-split |

[Optional]
Minimum file size in KB to split into ranges when downloading. Set to -1 for no splits | #### Example Export release bundle named "myApp" and version 1.0.0 - jf rbe myApp 1.0.0 +``` +jf rbe myApp 1.0.0 +``` #### Example Download to a specific location - jf rbe myApp 1.0.0 /user/mybundle/ - +``` +jf rbe myApp 1.0.0 /user/mybundle/ +``` ## Importing Release Bundle archive Import a Release Bundle archive from a release bundle exported zip file. Please note this functionality only works on Edge nodes within an air-gapped environment. -| | | -|------------------------|----------------------------------------------------------------------------------| -| Command-name | release-bundle-import | -| Abbreviation | rbi | -| Command arguments | | -| path to archive | Path to the release bundle archive on the filesystem | -| Command options | | -| --project |

[Optional]

Project key associated with the Release Bundle version.

| -| --server-id |

[Optional]

Platform server ID configured using the config command.

| +| | | +|------------------------|------------------------------------------------------------------------------| +| Command-name | release-bundle-import | +| Abbreviation | rbi | +| Command arguments | | +| path to archive | Path to the release bundle archive on the filesystem | +| Command options | | +| --project |

[Optional]
Project key associated with the Release Bundle version.

| +| --server-id |

[Optional]
Platform server ID configured using the config command.

| #### Example Import a Release Bundle named "myExportedApp" and version 1.0.0 - jf rbi ./myExportedApp.zip - +``` +jf rbi ./myExportedApp.zip +``` diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-distribution.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-distribution.md index 615dfeb..fa12d0f 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-distribution.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-distribution.md @@ -41,7 +41,7 @@ This commands creates and updates an unsigned Release Bundle on JFrog Distributi | Command options | | | --server-id |

[Optional]
Artifactory server ID configured using the config command.

| | --spec |

[Optional]
Path to a file spec. For more details, please refer to Using File Specs.

| -| --spec-vars |

[Optional]
List 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}.

| +| --spec-vars |

[Optional]
List of Semicolon-separated 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}.

| | --target-props |

[Optional]
The list of properties, in the form of key1=value1;key2=value2,..., to be added to the artifacts after distribution of the release bundle.

| | --target |

[Optional]
The target path for distributed artifacts on the edge node. If not specified, the artifacts will have the same path and name on the edge node, as on the source Artifactory server. For flexibility in specifying the distribution path, you can include placeholders in the form of {1}, {2} which are replaced by corresponding tokens in the pattern path that are enclosed in parenthesis.

| | --dry-run |

[Default: false]
Set to true to disable communication with JFrog Distribution.

| diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-your-source-code.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-your-source-code.md index 5b9c321..dadb422 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-your-source-code.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-your-source-code.md @@ -52,7 +52,7 @@ This command also supports the following Advanced Scans with the **Advanced Secu | --exclude-test-deps |

[Default: false] [Gradle]
Set to true if you'd like to exclude Gradle test dependencies from Xray scanning.

| | --requirements-file |

[Optional] [Pip]
Defines pip requirements file name. For example: 'requirements.txt'

| | --working-dirs |

[Optional]
A comma-separated list of relative working directories, to determine the audit targets locations.

If flag isn't provided, a recursive scan is triggered from the root directory of the project. | -| --exclusions |

[Default: *.git*;*node_modules*;*target*;*venv*;*test*]
List of exclusions separated by semicolons, utilized to skip sub-projects from undergoing an audit. These exclusions may incorporate the * and ? wildcards.

| +| --exclusions |

[Default: *.git*;*node_modules*;*target*;*venv*;*test*]
List of Semicolon-separated exclusions, utilized to skip sub-projects from undergoing an audit. These exclusions may incorporate the * and ? wildcards.

| | --fixable-only |

[Optional]
Set to true if you wish to display issues that have a fix version only.

| | --min-severity |

[Optional]
Set the minimum severity of issues to display. The following values are accepted: Low, Medium, High or Critical

| | --go |

[Default: false]
Set to true to request audit for a Go project.

| diff --git a/jfrog-applications/jfrog-cli/get-started/configurations/setting-up-a-ci-pipeline.md b/jfrog-applications/jfrog-cli/get-started/configurations/setting-up-a-ci-pipeline.md deleted file mode 100644 index f2152c2..0000000 --- a/jfrog-applications/jfrog-cli/get-started/configurations/setting-up-a-ci-pipeline.md +++ /dev/null @@ -1,27 +0,0 @@ -# Setting up a CI Pipeline - -The **ci-setup** command allows setting up a basic CI pipeline with the JFrog Platform, while automatically configuring the JFrog Platform to serve the pipeline. It is an interactive command, which prompts you with a series for questions, such as your source control details, your build tool, build command and your CI provider. The command then uses this information to do following: - -* Create the repositories in JFrog Artifactory, to be used by the pipeline to resolve dependencies. -* Configure JFrog Xray to scan the build. -* Generate a basic CI pipeline, which builds and scans your code. - -You can use the generated CI pipeline as a working starting point and then expand it as needed. - -The command currently supports the following package managers: - -* Maven -* Gradle -* npm. - -and the following CI providers: - -* JFrog Pipelines -* Jenkins -* GitHub Actions. - -Usage: - -``` -jf ci-setup -``` From ea7060707bb781456d3c33d36f8937da55ca3515 Mon Sep 17 00:00:00 2001 From: Michael Sverdlov Date: Thu, 18 Apr 2024 19:08:07 +0300 Subject: [PATCH 9/9] fix docs --- .../managing-configuration-entities.md | 8 ++-- .../release-lifecycle-management.md | 40 +++++++++---------- ...rring-files-between-artifactory-servers.md | 7 +++- 3 files changed, 29 insertions(+), 26 deletions(-) diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/managing-configuration-entities.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/managing-configuration-entities.md index 23d25ac..854ab86 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/managing-configuration-entities.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/managing-configuration-entities.md @@ -154,7 +154,7 @@ 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 the **jf rt repo-template** command. +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 the **jf rt repo-template** command. ### Creating or Configuration Template @@ -259,11 +259,11 @@ 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 the **jf rt replication-template** command. +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 the **jf rt replication-template** command. ### Creating a Configuration Template -This command creates a configuration template file, which should be used as an argument for the **jf rt replication-create** command. +This command creates a configuration template file, which will be used as an argument for the **jf rt replication-create** command. 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. @@ -378,7 +378,7 @@ These commands create/update a permission target. The commands accept as an argu | Command-name | permission-target-create / permission-target-update | | Abbreviation | rt ptc / rt ptu | | 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. | +| template path | Specifies the local file system path for the template file to be used for the permission target creation or update. The template should be created using the "jf rt ptt" command. | | Command-name | permission-target-create / permission-target-update | | Abbreviation | rt ptc / rt ptu | | Command options | | diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/release-lifecycle-management.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/release-lifecycle-management.md index 614356a..0a08ca5 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/release-lifecycle-management.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/release-lifecycle-management.md @@ -98,16 +98,16 @@ The file spec may be of one of the following creation sources: |------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Command-name | release-bundle-create | | Abbreviation | rbc | +| Command arguments | | +| release bundle name | Name of the newly created Release Bundle. | +| release bundle version | Version of the newly created Release Bundle. | | Command options | | | --project |

[Optional]
Project key associated with the created Release Bundle version.

| | --server-id |

[Optional]
Platform server ID configured using the config command.

| | --signing-key |

[Mandatory]
The GPG/RSA key-pair name given in Artifactory.

| | --spec |

[Optional]
Path to a File Spec.

| | --spec-vars |

[Optional]
List of Semicolon-separated variables in the form of "key1=value1;key2=value2;..." (wrapped by quotes) to be replaced in the File Spec. In the File Spec, the variables should be used as follows: ${key1}.

| -| --sync |

[Default: false]
Set to true to run synchronously.

| -| Command arguments | | -| release bundle name | Name of the newly created Release Bundle. | -| release bundle version | Version of the newly created Release Bundle. | +| --sync |

[Default: false]
Set to true to run synchronously.

| | ### Examples #### Example 1 @@ -144,17 +144,17 @@ This command allows promoting a release bundle to a target environment. |------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Command-name | release-bundle-promote | | Abbreviation | rbp | +| Command arguments | | +| release bundle name | Name of the Release Bundle to promote. | +| release bundle version | Version of the Release Bundle to promote. | +| environment | Name of the target environment for the promotion. | | Command options | | | --input-repos |

[Optional]
A list of semicolon-separated repositories to include in the promotion. If this property is left undefined, all repositories (except those specifically excluded) are included in the promotion. If one or more repositories are specifically included, all other repositories are excluded.

| | --exclude-repos |

[Optional]
A list of semicolon-separated repositories to exclude from the promotion.

| | --project |

[Optional]
Project key associated with the Release Bundle version.

| | --server-id |

[Optional]
Platform server ID configured using the config command.

| | --signing-key |

[Mandatory]
The GPG/RSA key-pair name given in Artifactory.

| -| --sync |

[Default: false]
Set to true to run synchronously.

| -| Command arguments | | -| release bundle name | Name of the Release Bundle to promote. | -| release bundle version | Version of the Release Bundle to promote. | -| environment | Name of the target environment for the promotion. | +| --sync |

[Default: false]
Set to true to run synchronously.

| | ### Examples #### Example 1 @@ -197,6 +197,9 @@ This command distributes a release bundle to an edge node. |------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Command-name | release-bundle-distribute | | Abbreviation | rbd | +| Command arguments | | +| release bundle name | Name of the release bundle to distribute. | +| release bundle version | Version of the release bundle to distribute. | | Command options | | | --city |

[Default: *]
Wildcard filter for site city name.

| | --country-codes |

[Default: *]
Semicolon-separated list of wildcard filters for site country codes.

| @@ -209,10 +212,7 @@ This command distributes a release bundle to an edge node. | --project |

[Optional]
Project key associated with the Release Bundle version.

| | --server-id |

[Optional]
Platform server ID configured using the config command.

| | --site |

[Default: *]
Wildcard filter for site name.

| -| --sync |

[Default: false]
Set to true to run synchronously.

| -| Command arguments | | -| release bundle name | Name of the release bundle to distribute. | -| release bundle version | Version of the release bundle to distribute. | +| --sync |

[Default: false]
Set to true to run synchronously.

| | **Distribution Rules Structure** ```json @@ -275,15 +275,15 @@ Deleting locally means distributions of the release bundle will not be deleted. |------------------------|----------------------------------------------------------------------------------------------------------------------------------------| | Command-name | release-bundle-delete-local | | Abbreviation | rbdell | +| Command arguments | | +| release bundle name | Name of the release bundle to distribute. | +| release bundle version | Version of the release bundle to distribute. | +| environment | If provided, all promotions to this environment are deleted. Otherwise, the release bundle is deleted locally with all its promotions. | | Command options | | | --project |

[Optional]
Project key associated with the Release Bundle version.

| | --quiet |

[Default: $CI]
Set to true to skip the delete confirmation message.

| | --server-id |

[Optional]
Platform server ID configured using the config command.

| | --sync |

[Default: false]
Set to true to run synchronously.

| -| Command arguments | | -| release bundle name | Name of the release bundle to distribute. | -| release bundle version | Version of the release bundle to distribute. | -| environment | If provided, all promotions to this environment are deleted. Otherwise, the release bundle is deleted locally with all its promotions. | ### Examples #### Example 1 @@ -314,6 +314,9 @@ This command will delete distributions of a release bundle from edge nodes. |------------------------|---------------------------------------------------------------------------------------------------------------------------------------------| | Command-name | release-bundle-delete-remote | | Abbreviation | rbdelr | +| Command arguments | | +| release bundle name | Name of the release bundle to distribute. | +| release bundle version | Version of the release bundle to distribute. | | Command options | | | --city |

[Default: *]
Wildcard filter for site city name.

| | --country-codes |

[Default: *]
Semicolon-separated list of wildcard filters for site country codes.

| @@ -325,9 +328,6 @@ This command will delete distributions of a release bundle from edge nodes. | --server-id |

[Optional]
Platform server ID configured using the config command.

| | --site |

[Default: *]
Wildcard filter for site name.

| | --sync |

[Default: false]
Set to true to run synchronously.

| -| Command arguments | | -| release bundle name | Name of the release bundle to distribute. | -| release bundle version | Version of the release bundle to distribute. | ### Examples #### Example 1 diff --git a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/transferring-files-between-artifactory-servers.md b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/transferring-files-between-artifactory-servers.md index c2c7033..17d9470 100644 --- a/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/transferring-files-between-artifactory-servers.md +++ b/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/transferring-files-between-artifactory-servers.md @@ -100,7 +100,9 @@ To install the **data-transfer** user plugin on the source machine manually, fol Install JFrog CLI on your source instance by using one of the \[#JFrog CLI Installers]. For example: -`curl -fL https://install-cli.jfrog.io | sh` +```sh +curl -fL https://install-cli.jfrog.io | sh +``` **Note** @@ -152,9 +154,10 @@ Follows these steps to installing JFrog CLI on that machine. 1. Install JFrog CLI by using one of the \[#JFrog CLI Installers]. For example: - ``` + ```sh curl -fL https://install-cli.jfrog.io | sh ``` + 2. If your source instance is accessible only through an HTTP/HTTPS proxy, set the proxy environment variable as described \[#here]. 3. Configure the connection details of the source Artifactory instance with your admin credentials. Run the following command and follow the instructions.