Use Pnpm with Jfrog CLI

This procedure is for teams that use pnpm for JavaScript or TypeScript builds and use JFrog Artifactory as an npm registry. JFrog CLI (jf) exposes jf pnpm so you can run pnpm install and pnpm publish with optional build-info collection and later publish that build info to Artifactory.

Why use it: You keep using pnpm as usual while the CLI can record dependency and artifact metadata for build-info, which supports traceability, promotion, and integration with other JFrog features.

Wider context: This is part of JFrog CLI Artifactory workflows. You still configure registry URLs and npm auth for pnpm (for example .npmrc).

What Do You Need Before You Start?

Quick verification

jf --version
jf pnpm --help
pnpm --version
node --version

How components interact

Do not rely on CLI screenshots; use the command examples below as your source of truth.

Important limitations and behaviors

The following behaviors apply to the pnpm integration in JFrog CLI (product expectations and pnpm semantics):

How Do You Integrate pnpm With Artifactory?

Use the following sections in order, or skip steps that do not apply to your workflow.

• Important limitations and behaviors
• Step 1: Register Artifactory in the CLI
• Step 2: Point pnpm at Artifactory
• Step 3: Install dependencies with JFrog CLI
• Step 4: Publish packages with JFrog CLI
• Step 5: Publish build info to Artifactory
• Step 6: Run other pnpm subcommands (pass-through)

Step 1: Register Artifactory in the CLI

To register Artifactory in the JFrog CLI:

1. Run jf config add and complete the prompts. A server is added so jf can reach JFrog Artifactory. During setup, choose or note a server ID for later use.

   Bash

   jf config add

   When setup completes, jf can resolve optional flags such as --server-id on jf pnpm.

2. Optional: Use the short form jf c add. The jfrog executable name is equivalent to jf in v2.

CI and automation: jf config add is interactive by default. For pipelines, configure the server non-interactively (for example with JFROG_CLI_HOME, environment variables such as JF_URL and JF_ACCESS_TOKEN when using setup-jfrog-cli, or the flags your JFrog CLI version supports for jf config add). For more information, see the JFrog CLI documentation for the options available in your release.

Step 2: Point pnpm at Artifactory

To point pnpm at Artifactory:

.npmrc is required for pnpm to reach Artifactory with the correct registry and credentials. Complete this step before jf pnpm install or jf pnpm publish.

1. Configure registry and authentication outside this procedure's jf syntax (for example .npmrc in the project or user home, or pnpm config set). Registry URLs typically follow this pattern:

   Text

   https://<host>/artifactory/api/npm/<repository_key>/

2. For token-based authentication, set the token value to a real secret at runtime. Do not paste tokens into documentation or source control. Example shape only:

   Text

   //<host>/artifactory/api/npm/<repository_key>/:_authToken=<Token>

Step 3: Install dependencies with JFrog CLI

To install dependencies with JFrog CLI integration:

CLI command

jf pnpm install [<pnpm_arguments>] [--server-id <server_id>] [--build-name <build_name>] [--build-number <build_number>] [--project <project_key>] [--module <module_name>]

Full example (sample values)

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

If pnpm install succeeds but build-info collection fails, the CLI may log a warning and still exit successfully for the install.

Step 4: Publish packages with JFrog CLI

To publish packages with JFrog CLI integration:

CLI command

jf pnpm publish [<pnpm_arguments>] [--server-id <server_id>] [--build-name <build_name>] [--build-number <build_number>] [--project <project_key>] [--module <module_name>]

Short form: jf pnpm p with the same optional JFrog arguments.

Full example (sample values)

jf pnpm publish --no-git-checks --build-name my-application --build-number 2026.03.30.1

Workspace example (sample values)

jf pnpm publish -r --no-git-checks --build-name my-application --build-number 2026.03.30.1

For workspace publishes with build-info, the implementation may use pnpm-publish-summary.json (--report-summary).

Step 5: Publish build info to Artifactory

To publish build info to Artifactory:

After jf pnpm install and/or jf pnpm publish with both <build_name> and <build_number>, publish the collected build info.

CLI command

jf rt build-publish <build_name> <build_number>

Alias: jf rt bp <build_name> <build_number>

Full example (sample values)

jf rt build-publish my-application 2026.03.30.1

Step 6: Run other pnpm subcommands (pass-through)

To run other pnpm subcommands through JFrog CLI:

CLI command

jf pnpm <subcommand> [<pnpm_arguments>]

pnpm add: jf pnpm add is a direct pass-through to pnpm. The CLI does not collect or adjust build-info for add—use jf pnpm install (after lockfile changes) when you need integrated build-info.

Full example (sample values)

jf pnpm run build
jf pnpm ci
jf pnpm add lodash

For build-info collection, use jf pnpm install (or jf pnpm publish) as in Steps 3–4.

Where Can You Get More Help?

Built-in help

jf pnpm --help

If jf pnpm --help fails, your CLI build does not include the pnpm integration yet. Upgrade to a release that includes it.

CI/CD example (GitHub Actions)

Use pnpm 10 and a compatible Node.js version (for pnpm 10, Node 20+). Supply registry auth via .npmrc or your secret store. Do not commit <Token> values.

The steps that invoke jf pnpm install require a JFrog CLI build that provides jf pnpm.

steps:
  - uses: actions/checkout@v4
  - uses: pnpm/action-setup@v4
    with:
      version: 10
  - uses: actions/setup-node@v4
    with:
      node-version: "20"
      cache: "pnpm"
  - uses: jfrog/setup-jfrog-cli@v4
    env:
      JF_URL: ${{ vars.JF_URL }}
      JF_ACCESS_TOKEN: ${{ secrets.JF_ACCESS_TOKEN }}
  - run: jf pnpm install --build-name=my-app --build-number=${{ github.run_number }}
  - run: jf rt build-publish my-app ${{ github.run_number }}

Troubleshooting

Integrated subcommands (summary)

Next steps

• Publish or promote builds according to your JFrog CLI and JFrog Artifactory documentation.
• Compare with jf npm and jf yarn on the same documentation site if you maintain multiple package managers.

Frequently Asked Questions

Why does jf pnpm say the command is not found?

Your CLI build might not include the pnpm integration yet. Upgrade to a release that includes jf pnpm.

Which pnpm and Node.js versions are supported?

pnpm 10.x and a compatible Node.js version (Node 20+ for pnpm 10). See What Do You Need Before You Start?.

How do I collect build info?

Pass --build-name and --build-number to jf pnpm install or jf pnpm publish, then run jf rt build-publish. See Step 5.

Why is .npmrc mandatory?

jf pnpm relies on pnpm for registry resolution. .npmrc supplies the Artifactory registry URL and auth. See Step 2.

Are git dependencies or pnpm patch supported for build-info?

No. See Important limitations and behaviors.

Related Topics

• JFrog CLI
• Package managers integration ( jf npm, jf yarn, and related topics on the same site)
• JFrog Artifactory npm repository documentation on docs.jfrog.com
• Native mode (comparison context for npm clients; jf pnpm does not use the same native flags as jf npm)