Creating and publishing private packages

To share your code with a limited set of users or teams, you can publish private user-scoped or Org-scoped packages to the npm registry.

For more information on scopes and private packages, see “About scopes” and “About private packages”.

Note: Before you can publish private user-scoped npm packages, you must sign up for a paid npm user account. Additionally, to publish private Org-scoped packages, you must create an npm user account, then create a paid npm Org.

Overview

  1. Create your package
  2. Review package contents for sensitive or unnecessary information
  3. Publish your package

Creating a private package

  1. If you are using npmrc to manage accounts on multiple registries, on the command line, switch to the appropriate profile:
     npmrc <profile-name>
    
  2. On the command line, create a directory for your package:
     mkdir my-test-package
    
  3. Navigate to the root directory of your package:
     cd my-test-package
    
  4. If you are using git to manage your package code, in the package root directory, run the following commands, replacing git-remote-url with the git remote URL for your package:
     git init
     git remote add origin git://git-remote-url
    
  5. In the package root directory, run the npm init command and pass the scope to the scope flag:
    • For an Org-scoped package, replace my-org with the name of your Org:
    • For a user-scoped package, replace my-username with your username:
  6. Respond to the prompts to generate a package.json file. For help naming your package, see “Package name guidelines”.
  7. Create a README file that explains what your package code is and how to use it.
  8. In your preferred text editor, write the code for your package.

Reviewing package contents for sensitive or unnecessary information

Publishing sensitive information to the registry can harm your users, compromise your development infrastructure, be expensive to fix, and put you at risk of legal action. We strongly recommend removing sensitive information, such as private keys, passwords, [personally identifiable information][pii] (PII), and credit card data before publishing your package to the registry. Even if your package is private, sensitive information can be exposed if the package is made public or downloaded to a computer that can be accessed by more users than intended.

For less sensitive information, such as testing data, use a .npmignore or .gitignore file to prevent publishing to the registry. For more information, see this article.

Publishing private packages

By default, scoped packages are published with private visibility.

  1. On the command line, navigate to the root directory of your package.
    cd /path/to/package
    
  2. To publish your private package to the npm registry, run:
    npm publish
    
  3. To see your private package page, visit https://npmjs.com/package/package-name, replacing package-name with the name of your package. Private packages will say private below the package name on the npm website.

private package page showing private below package name

For more information on the publish command, see the CLI documentation.


< Creating and publishing scoped public packages | Package name guidelines >