JFrog Platform

https://docs.jfrog.com/
Admin
JFrog Platform is a centralized DevOps software supply chain management solution that enables...
Tokens:3,862,789
Snippets:33,275
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install plugin example

Source: https://docs.jfrog.com/integrations/docs/jfrog-cli-plugins

Example of installing a plugin named 'my-plugin' from the private registry.

```bash
jf plugin install my-plugin
```

--------------------------------

### Example: Install dependencies and collect build-info

Source: https://docs.jfrog.com/artifactory/docs/jf-ruby

An example of installing dependencies with specific build name and number.

```Shell
jf ruby bundle install --build-name=my-app --build-number=1
```

--------------------------------

### Example Poetry install command

Source: https://docs.jfrog.com/artifactory/docs/pypi-repositories

Example command to install a package from a specific repository.

```bash
poetry add --source pypi-local my_pypi_package
```

--------------------------------

### Example: install to a custom local path

Source: https://docs.jfrog.com/artifactory/docs/skills-repositories

Example command installing skill 'myskill' to './vendor/skills' from repository 'skills-local' with version 'latest'.

```Shell
jf agent skills install myskill --path ./vendor/skills --repo skills-local --version latest

```

--------------------------------

### Example: install the latest version

Source: https://docs.jfrog.com/artifactory/docs/skills-repositories

Example command installing the latest version of skill 'myskill' from repository 'skills-local' for harness 'cursor'.

```Shell
jf agent skills install myskill --repo skills-local --harness cursor --version latest

```

--------------------------------

### Install specific plugin version example

Source: https://docs.jfrog.com/integrations/docs/jfrog-cli-plugins

Example of installing version v1.0.0 of plugin 'my-plugin'.

```bash
jf plugin install my-plugin@v1.0.0
```

--------------------------------

### Install latest plugin (full example)

Source: https://docs.jfrog.com/artifactory/docs/jf-rt-transfer-plugin-install

Full example installing the latest plugin version on server 'my-server'. Omitting --version installs the latest available version.

```bash
jf rt transfer-plugin-install my-server
```

--------------------------------

### Install specific plugin version (full example)

Source: https://docs.jfrog.com/artifactory/docs/jf-rt-transfer-plugin-install

Full example installing plugin version 1.2.3 on server 'my-server'.

```bash
jf rt transfer-plugin-install my-server --version 1.2.3
```

--------------------------------

### Example JSON response for install

Source: https://docs.jfrog.com/artifactory/docs/jf-skills

Example JSON response from the install command when --format json is used.

```json
{
  "slug": "myskill",
  "version": "1.0.0",
  "results": [
    {
      "agent": "cursor",
      "scope": "project",
      "path": "/path/to/project/.cursor/skills/myskill",
      "status": "ok",
      "detail": "Executed successfully with no issues."
    }
  ]
}
```

--------------------------------

### jf package-alias install examples

Source: https://docs.jfrog.com/artifactory/docs/jfrog-cli-package-alias

Examples of the install subcommand: without flags for all tools, with a comma-separated list, and with a single tool.

```shell
# Install aliases for all supported tools
jf package-alias install

# Install aliases for specific tools only
jf package-alias install --packages=npm,mvn,go

# Install aliases for a single tool
jf package-alias install --packages=npm
```

--------------------------------

### Full install example with build-info

Source: https://docs.jfrog.com/artifactory/docs/jf-agent-apm

Full example of installing dependencies with build-info. After a successful run, prints 'apm install finished successfully' and, when build-info is collected, 'Collecting APM build info...' and 'APM build info saved for <build-name>/<build-number>: <n> dependencies.'

```bash
jf agent apm install --build-name=docs-apm --build-number=1
```

--------------------------------

### Persistent APT install example with curl

Source: https://docs.jfrog.com/artifactory/docs/jf-apt

Example of installing curl using the persistent APT setup.

```shell
sudo jf apt install curl
```

--------------------------------

### jf package-alias install output

Source: https://docs.jfrog.com/artifactory/docs/jfrog-cli-package-alias

Example output of the install subcommand, showing the created aliases, PATH setup instructions, and a verification command.

```text
[Info] Creating package alias directories...
[Info] Created 15 aliases in /Users/you/.jfrog/package-alias/bin
[Info] Configured packages: mvn, gradle, npm, yarn, pnpm, go, pip, pipenv, poetry, dotnet, nuget, docker, gem, bundle, apk
[Info]
[Info] To enable package aliasing, add this to your shell configuration:
[Info]   export PATH="/Users/you/.jfrog/package-alias/bin:$PATH"
[Info]
[Info] Then run: hash -r
[Info]
[Info] Package aliasing is now installed. Run 'jf package-alias status' to verify.
```

--------------------------------

### Batch Deployment CLI Example

Source: https://docs.jfrog.com/ai-ml/docs/batch-deployments

Example batch deployment command using the model built in the Get Started section. Deploys the churn_model with 4 pods, 3 CPUs, and 1024 MB memory.

```shell
frogml models deploy batch \
    --model-id churn_model \
    --build-id 7121b796-5027-11ec-b97c-367dda8b746f \
    --pods 4 \
    --cpus 3 \
    --memory 1024
```

--------------------------------

### jf pnpm install full example

Source: https://docs.jfrog.com/artifactory/docs/use-pnpm-with-jfrog-cli

Example install command with sample values for build name and number. If build-info collection fails, the CLI may log a warning but still exit successfully.

```Bash
jf pnpm install --frozen-lockfile --build-name my-application --build-number 2026.03.30.1

```

--------------------------------

### Start Additional HA Nodes with Docker

Source: https://docs.jfrog.com/installation/docs/docker

Commands to start the second and third Artifactory nodes for an HA setup. Replace placeholders like <pro|oss|cpp-ce> and <version> with actual values. The example uses artifactory-pro:7.161.15.

```bash
# Start the second node:
docker run --name artifactory_2 -v $JFROG_HOME/artifactory/var/:/var/opt/jfrog/artifactory -d -p 8083:8081 -p 8084:8082 releases-docker.jfrog.io/jfrog/artifactory-<pro|oss|cpp-ce>:<version>
# Example:
# docker run --name artifactory_2 -v $JFROG_HOME/artifactory/var/:/var/opt/jfrog/artifactory -d -p 8083:8081 -p 8084:8082 releases-docker.jfrog.io/jfrog/artifactory-pro:7.161.15

# Start the third node (if applicable):
docker run --name artifactory_3 -v $JFROG_HOME/artifactory/var/:/var/opt/jfrog/artifactory -d -p 8085:8081 -p 8086:8082 releases-docker.jfrog.io/jfrog/artifactory-<pro|oss|cpp-ce>:<version>
# Example:
# docker run --name artifactory_3 -v $JFROG_HOME/artifactory/var/:/var/opt/jfrog/artifactory -d -p 8085:8081 -p 8086:8082 releases-docker.jfrog.io/jfrog/artifactory-pro:7.161.15
```

--------------------------------

### Example npm Install Command

Source: https://docs.jfrog.com/artifactory/docs/npm-repositories

Example command to install the 'colors' package using npm install.

```shell
npm install colors
```

--------------------------------

### Example: collect-env, add-git, and publish build-info

Source: https://docs.jfrog.com/artifactory/docs/build-tool-commands

Concrete example using build name 'my-app' and build number '42'.

```bash
jf rt build-collect-env my-app 42
jf rt build-add-git my-app 42
jf rt build-publish my-app 42
```

--------------------------------

### Full Example Implementation

Source: https://docs.jfrog.com/integrations/docs/cli-command-summaries

Complete Go example showing both steps: implementing the interface and recording data. Includes a sample data structure and markdown generation from multiple files.

```Go
package mycommand

import (
    "fmt"
    "strings"

    "github.com/jfrog/jfrog-cli-core/v2/artifactory/utils/commandsummary"
)

// Step 1. Implement the CommandSummaryInterface
type CommandStruct struct{}

type singleRecordedObject struct {
    Name   string `json:"name"`
    Status string `json:"status"`
}

func (cs *CommandStruct) GenerateMarkdownFromFiles(dataFilePaths []string) (markdown string, err error) {
    // Aggregate all the results into a slice
    var recordedObjects []*singleRecordedObject
    for _, path := range dataFilePaths {
        var singleObject singleRecordedObject
        if err = commandsummary.UnmarshalFromFilePath(path, &singleObject); err != nil {
            return "", err
        }
        recordedObjects = append(recordedObjects, &singleObject)
    }

    // Create markdown
    var results strings.Builder
    results.WriteString("# Command Summary\n\n")
    results.WriteString("| Name | Status |\n")
    results.WriteString("|------|--------|\n")
    for _, obj := range recordedObjects {
        results.WriteString(fmt.Sprintf("| %s | %s |\n", obj.Name, obj.Status))
    }

    markdown = results.String()
    return
}

// Step 2. Record data during runtime
func recordCommandSummary(data any) (err error) {
    if !commandsummary.ShouldRecordSummary() {
        return nil
    }

    commandSummaryImplementation, err := commandsummary.New(&CommandStruct{}, "CommandName")
    if err != nil {
        return err
    }

    return commandSummaryImplementation.Record(data)
}
```

--------------------------------

### Example ~/.bundle/config after setup

Source: https://docs.jfrog.com/artifactory/docs/jf-ruby

Example contents of ~/.bundle/config after running jf setup ruby with the gems-virtual repository. Shows the mirror and per-host credentials entries.

```yaml
---
BUNDLE_MIRROR__HTTPS://RUBYGEMS__ORG/: "https://<USER>:<PASSWORD>@mycompany.jfrog.io/artifactory/api/gems/gems-virtual/"
BUNDLE_MYCOMPANY__JFROG__IO: "<USER>:<PASSWORD>"

```

--------------------------------

### Example DNF install of httpd

Source: https://docs.jfrog.com/artifactory/docs/rpm-repositories

Example DNF command to install the httpd package.

```bash
dnf install httpd
```

--------------------------------

### Run Pre-Transfer Checks with --prechecks

Source: https://docs.jfrog.com/artifactory/docs/jf-rt-transfer-files

Runs pre-transfer checks to validate connectivity and plugin installation before starting a large transfer. The full example shows the expected output when all checks pass.

```bash
jf rt transfer-files <source-server-id> <target-server-id> --prechecks
```

```bash
jf rt transfer-files source-server target-server --prechecks
```

```text
[Info] Running pre-transfer checks...
[Info] data-transfer plugin found on source instance.
[Info] Source and target instances are reachable.
[Info] Pre-transfer checks passed.
```

--------------------------------

### Use custom home directory (full example)

Source: https://docs.jfrog.com/artifactory/docs/jf-rt-transfer-plugin-install

Full example installing with custom home directory '/opt/my-jfrog' on server 'my-server'.

```bash
jf rt transfer-plugin-install my-server --home-dir /opt/my-jfrog
```

--------------------------------

### Install npm package with Yarn (example)

Source: https://docs.jfrog.com/artifactory/docs/npm-repositories

Example of installing the lodash package using Yarn.

```Shell
yarn add lodash
```

--------------------------------

### Example: replication_to_federation with --repos

Source: https://docs.jfrog.com/artifactory/docs/migrate-push-replication-to-unidirectional-federation

Example command using actual source and target URLs and repository keys. Replace tokens with real values.

```Bash
jf federation-migrator replication_to_federation \
  https://source.example.com \
  <source-token> \
  https://target.example.com \
  <target-token> \
  --repos libs-release-local,libs-snapshot-local
```

--------------------------------

### Example: dnf install without weak dependencies

Source: https://docs.jfrog.com/artifactory/docs/rpm-repositories

Example of the previous command using the package simple-package.

```shell
dnf --setopt=install_weak_deps=False install -y simple-package
```

--------------------------------

### Install Nix package with nix-shell (example)

Source: https://docs.jfrog.com/artifactory/docs/nix-repositories

Example of installing the neovim package using nix-shell.

```shell
nix-shell -p neovim
```

--------------------------------

### Full crate publish and build-info upload example

Source: https://docs.jfrog.com/artifactory/docs/jf-cargo

A complete workflow example showing both the publish command and the build-publish command.

```bash
jf cargo publish --registry jfrog-local --build-name=docs-cargo --build-number=1
jf rt build-publish docs-cargo 1
```

--------------------------------

### Install Nix package with nix-env (example)

Source: https://docs.jfrog.com/artifactory/docs/nix-repositories

Example of installing the neovim package using nix-env.

```shell
nix-env -iA nixpkgs.neovim
```

--------------------------------

### Example: configure with GPG verification

Source: https://docs.jfrog.com/artifactory/docs/jf-apt

Example command using a server ID 'my-server', repository 'debian-virtual', distribution 'bookworm', component 'main', and --import-key. The expected output shows the installed key path and the written sources list file.

```shell
sudo jf setup apt \
  --server-id=my-server \
  --repo=debian-virtual \
  --dist=bookworm \
  --component=main \
  --import-key

```

```text
Installed GPG public key at /etc/apt/keyrings/jfrog-debian-virtual-bookworm.asc
Wrote /etc/apt/sources.list.d/jfrog-debian-virtual-bookworm.list
Successfully configured apt to use JFrog Artifactory repository 'debian-virtual'.

```

--------------------------------

### Example opkg install command

Source: https://docs.jfrog.com/artifactory/docs/opkg-repositories

Example command that installs the my-app package from your Artifactory repository.

```shell
opkg install my-app
```

--------------------------------

### Example Pip install command

Source: https://docs.jfrog.com/artifactory/docs/pypi-repositories

Example command to install a specific Python package using Pip.

```bash
pip3 install my_pypi_package
```

--------------------------------

### Example: Configure deployment credentials on Windows

Source: https://docs.jfrog.com/artifactory/docs/rubygems-repositories

Example of the Windows deployment credentials command with sample values.

```Shell
curl.exe -L -u jeffry:Random_TokenDh9872tfW4h784 https://company.jfrog.io/artifactory/api/gems/rubygems-local/api/vi/api_key.yaml | Out-File ~/.gem/credentials ~/.gem/credentials -Encoding "ASCII"
```
Tokens:
Raw