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.