Requires npm version 2 or greater
Scopes are used to group related packages together, and to create a namespace, like a domain, for npm modules. This is explained in more detail here.
If a package's name begins with @, then it is a scoped package. The scope is everything in between the @ and the slash.
@scope/project-name
Each npm user has their own scope.
@username/project-name
npm Orgs also have scopes.
@orgname/project-name
You can find more in depth information about scopes in the CLI documentation.
To create a scoped package, you simply use a package name that starts with your scope.
If you use npm init, you can add your scope as an option to that command.
npm init --scope=username
If you use the same scope all the time, you will probably want to set this option in your .npmrc file.
npm config set scope username
By default, scoped packages are private. To publish private modules, you need to be a paid private modules user.
Public scoped modules are free and don't require a paid subscription. To publish a public scoped module, set the access option when publishing it. This option will remain set for all subsequent publishes.
npm publish --access=public
To use a scoped package, simply include the scope wherever you use the package name.
In package.json:
On the command line:
npm install @username/project-name --saveIn a require statement:
var projectName = For information about using scoped private modules, visit docs.npmjs.com/private-modules/intro.
Last modified June 11, 2018 Found a typo? Send a pull request!