npm packages

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/harness/harness-cli/llms.txt

Use this file to discover all available pages before exploring further.

​

Overview

• Standard npm registry protocol
• Automatic metadata extraction from package.json
• Scoped package support (@org/package)
• Version management and dist-tags
• Seamless integration with npm, yarn, and pnpm

​

Pushing npm packages

hc artifact push npm <registry-name> <npm-tgz-path> \
  --pkg-url <pkg-url>

​

How it works

1. Validates the .tgz tarball format
2. Extracts package.json from the tarball
3. Reads package name and version from package.json
4. Builds the npm upload payload
5. Uploads the package to the registry

# In your package directory
npm pack
# Creates: your-package-1.0.0.tgz

hc artifact push npm my-npm-registry ./your-package-1.0.0.tgz \
  --pkg-url https://app.harness.io/registry/pkg

hc registry configure npm my-npm-registry

​

Installing npm packages

# Install from your private registry
npm install your-package

# Or with yarn
yarn add your-package

# Or with pnpm
pnpm add your-package

​

Registry configuration

​

Project-level configuration

registry=https://<registry-url>/
//registry-url/:_authToken=<your-harness-token>

​

Scoped packages

@myorg:registry=https://<registry-url>/
//registry-url/:_authToken=<your-harness-token>

​

Using the CLI

hc registry configure npm my-npm-registry \
  --scope @myorg \
  --project

​

Examples

# Pack and push a public package
npm pack
hc artifact push npm my-registry ./mypackage-1.0.0.tgz \
  --pkg-url https://app.harness.io/registry/pkg

​

Package.json requirements

{
  "name": "mypackage",
  "version": "1.0.0",
  "description": "My awesome package",
  "main": "index.js"
}

{
  "name": "@myorg/mypackage",
  "version": "1.0.0"
}

​

CI/CD integration

- name: Publish to Harness
  env:
    HARNESS_API_KEY: ${{ secrets.HARNESS_API_KEY }}
  run: |
    npm pack
    hc artifact push npm my-registry ./*.tgz \
      --pkg-url https://app.harness.io/registry/pkg

publish:
  script:
    - npm pack
    - hc artifact push npm my-registry ./*.tgz --pkg-url $PKG_URL
  variables:
    HARNESS_API_KEY: $HARNESS_TOKEN

​

Troubleshooting

# Check tarball contents
tar -tzf mypackage-1.0.0.tgz | grep package.json

# Verify package.json has name and version
npm pack --dry-run

# Create proper tarball
npm pack  # Don't use tar directly

hc auth status
hc registry list  # Verify registry exists

​

See also

• Registry configure command
• Artifact push command
• Artifact management guide