tessl/npm-npm

A package manager for JavaScript and the Node.js ecosystem

—

Pending

Quality

Pending

Does it follow best practices?

Impact

Pending

No eval scenarios have been run

Securityby

Pending

The risk profile of this skill

Overview

Eval results

Files

npm

Name: tessl/npm-npm
Author: tessl

npm is the official package manager for JavaScript and the Node.js ecosystem. It provides command-line tools for installing, managing, and publishing packages to the npm registry, as well as managing project dependencies and scripts.

Package Information

Package Name: npm
Package Type: npm
Language: JavaScript (Node.js)
Installation: Included with Node.js, or npm install -g npm to update

Core Imports

npm is a command-line tool and does not provide a programmatic API. It must be used via command-line interface or child process execution:

const { spawn } = require('child_process');

// Execute npm commands programmatically
const npmInstall = spawn('npm', ['install', 'lodash'], { stdio: 'inherit' });

For shell usage:

npm install <package>
npm publish
npm run <script>

Basic Usage

# Initialize a new project
npm init

# Install dependencies
npm install express
npm install --save-dev jest

# Install global packages
npm install -g typescript

# Run project scripts
npm run build
npm test

# Publish a package
npm publish

Architecture

npm CLI is built around several key command categories:

Package Management: Install, uninstall, update, and deduplicate packages
Registry Operations: Publish, unpublish, search, and view packages
Configuration: Manage npm configuration and authentication
Script Execution: Run package.json scripts and lifecycle hooks
Workspace Management: Handle monorepo workspaces and dependencies
Auditing and Security: Check for vulnerabilities and generate security reports

Capabilities

Package Management Commands

Core commands for installing and managing package dependencies in projects.

# Install packages from package.json
npm install
npm ci

# Add new dependencies
npm install <package>[@version]
npm install --save-dev <package>
npm install --global <package>

# Remove dependencies
npm uninstall <package>
npm uninstall --global <package>

# Update packages
npm update [package]
npm outdated

# Manage duplicate packages
npm dedupe
npm find-dupes

Package Management

Registry Operations

Commands for interacting with the npm registry and publishing packages.

# Publish packages
npm publish [tarball|folder]
npm unpublish <package>[@version]

# Search and view packages
npm search <search-term>
npm view <package>[@version] [field]

# Manage package versions
npm version <newversion>
npm dist-tag add <package>@<version> [tag]
npm dist-tag rm <package> <tag>
npm dist-tag ls [package]

# Deprecate packages
npm deprecate <package>[@version] <message>
npm undeprecate <package>[@version]

Registry Operations

Configuration Management

Commands for managing npm configuration, authentication, and user settings.

# Configuration management
npm config set <key> <value>
npm config get <key>
npm config delete <key>
npm config list
npm config edit

# User authentication
npm login
npm logout
npm whoami

# Registry and token management
npm adduser
npm token list
npm token create
npm token revoke <id>

Configuration

Script Execution

Execute package.json scripts and lifecycle hooks.

# Run package.json scripts
npm run <script-name>
npm run-script <script-name>

# Standard lifecycle scripts
npm start
npm test
npm stop
npm restart

# Script information
npm run
npm run-script --silent <script-name>

Workspace Management

Manage monorepo workspaces and workspace dependencies.

# Workspace operations
npm install --workspace=<workspace-name>
npm run <script> --workspace=<workspace-name>
npm run <script> --workspaces

# Workspace information
npm ls --workspaces
npm list --workspace=<workspace-name>

Auditing and Security

Security vulnerability scanning and reporting.

# Security auditing
npm audit
npm audit fix
npm audit fix --force

# Package integrity
npm verify
npm doctor

# Generate reports
npm sbom

Exit Codes

npm uses standard exit codes to indicate command success or failure:

0 - Success
1 - General error
2 - Misuse of shell command
3 - Internal npm error
4 - NPM configuration error
5 - Network error

Environment Variables

npm respects various environment variables for configuration:

# Common environment variables
NPM_CONFIG_REGISTRY=<registry-url>
NPM_CONFIG_CACHE=<cache-directory>
NPM_TOKEN=<authentication-token>
NODE_ENV=<environment>