Frecuentemente publicamos actualizaciones de nuestra documentación. Es posible que la traducción de esta página esté en curso. Para conocer la información más actual, visita la documentación en inglés. Si existe un problema con las traducciones en esta página, por favor infórmanos.

Configuring npm for use with GitHub Packages

You can configure npm to publish packages to Paquetes de GitHub and to use packages stored on Paquetes de GitHub as dependencies in an npm project.

Paquetes de GitHub is available with GitHub Free, GitHub Pro, GitHub Free for organizations, GitHub Team, GitHub Enterprise Cloud, Servidor de GitHub Enterprise 2.22, and GitHub One.


Paquetes de GitHub no está disponible para repositorios privados que pertenezcan a cuentas que utilicen planes tradicionales por repositorio. Paquetes de GitHub se encuentra disponible con GitHub Free, GitHub Pro, GitHub Free para organizaciones, GitHub Team, GitHub Enterprise Cloud, y GitHub One. Para obtener más información, consulta la sección "Productos de GitHub".

En este artículo

¿Te ayudó este documento?

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

O, learn how to contribute.

Authenticating to Paquetes de GitHub

Necesitas de un token de acceso para publicar, instalar, y borrar paquetes en Paquetes de GitHub. Puedes utilizar un token de acceso personal para autenticarte con tu nombre de usuario directamente en Paquetes de GitHub o en la API de GitHub. Cuando creas un token de acceso personal, puedes asignar al token diferentes ámbitos en función de tus necesidades.

To authenticate using a GitHub Actions workflow:

  • For package registries (PACKAGE-REGISTRY.pkg.github.com/OWNER/REPOSITORY/IMAGE-NAME), you can use a GITHUB_TOKEN.
  • For the container registry (ghcr.io/OWNER/IMAGE-NAME), you must use a personal access token.

Authenticating with a personal access token

Debes utilizar un token de acceso personal con los alcances adecuados para publicar e instalar paquetes en Paquetes de GitHub. Para obtener más información, consulta "Acerca de Paquetes de GitHub".

You can authenticate to Paquetes de GitHub with npm by either editing your per-user ~/.npmrc file to include your personal access token or by logging in to npm on the command line using your username and personal access token.

To authenticate by adding your personal access token to your ~/.npmrc file, edit the ~/.npmrc file for your project to include the following line, replacing TOKEN with your personal access token. Create a new ~/.npmrc file if one doesn't exist.

//npm.pkg.github.com/:_authToken=TOKEN

To authenticate by logging in to npm, use the npm login command, replacing USERNAME with your GitHub username, TOKEN with your personal access token, and PUBLIC-EMAIL-ADDRESS with your email address.

$ npm login --registry=https://npm.pkg.github.com
> Username: USERNAME
> Password: TOKEN
> Email: PUBLIC-EMAIL-ADDRESS

Authenticating with the GITHUB_TOKEN

Si estás utilizando un flujo de trabajo de GitHub Actions, puedes utilizar un GITHUB_TOKEN para publicar y consumir paquetes en Paquetes de GitHub sin que necesites almacenar y administrar un token de acceso personal. Para obtener más información, consulta la sección "Autenticarse con el GITHUB_TOKEN".

Publishing a package

By default, Paquetes de GitHub publishes a package in the GitHub repository you specify in the name field of the package.json file. For example, you would publish a package named @my-org/test to the my-org/test GitHub repository. You can add a summary for the package listing page by including a README.md file in your package directory. For more information, see "Working with package.json" and "How to create Node.js Modules" in the npm documentation.

You can publish multiple packages to the same GitHub repository by including a URL field in the package.json file. For more information, see "Publishing multiple packages to the same repository."

You can set up the scope mapping for your project using either a local .npmrc file in the project or using the publishConfig option in the package.json. Paquetes de GitHub only supports scoped npm packages. Scoped packages have names with the format of @owner/name. Scoped packages always begin with an @ symbol. You may need to update the name in your package.json to use the scoped name. For example, "name": "@codertocat/hello-world-npm".

Después de que publiques un paquete, puedes verlo en GitHub. Para obtener más información, consulta "Visualizar paquetes".

Publishing a package using a local .npmrc file

You can use an .npmrc file to configure the scope mapping for your project. In the .npmrc file, use the Paquetes de GitHub URL and account owner so Paquetes de GitHub knows where to route package requests. Using an .npmrc file prevents other developers from accidentally publishing the package to npmjs.org instead of Paquetes de GitHub. Dado que las letras mayúsculas no son compatibles, debes usar minúscula para el propietario del repositorio si el nombre de usuario o el nombre de la organización de GitHub contiene letras mayúsculas.

  1. Autentícate en Paquetes de GitHub. Para obtener más información, consulta "Autenticar a Paquetes de GitHub."

  2. En el mismo directorio que tu archivo package.json, crea o edita un archivo .npmrc para incluir una línea que especifique la URL de Paquetes de GitHub y el propietario de la cuenta. Reemplaza OWNER con el nombre de la cuenta de usuario u organización a la que pertenezca el repositorio que contiene tu proyecto.

    registry=https://npm.pkg.github.com/OWNER
  3. Agrega el archivo .npmrc al repositorio en donde Paquetes de GitHub pueda encontrar tu proyecto. Para obtener más información, consulta la sección "Agregar un archivo a un repositorio utilizando la línea de comandos".

  4. Verify the name of your package in your project's package.json. The name field must contain the scope and the name of the package. For example, if your package is called "test", and you are publishing to the "My-org" GitHub organization, the name field in your package.json should be @my-org/test.

  5. Verifica el campo repository en el package.json. de tu proyecto. El campo repository debe coincidir con la URL de tu repositorio de GitHub. Por ejemplo, si la URL de tu repositorio es github.com/my-org/test, entonces el campo de repositorio debe ser git://github.com/my-org/test.git.

  6. Publicar el paquete:

    $ npm publish

Publishing a package using publishConfig in the package.json file

You can use publishConfig element in the package.json file to specify the registry where you want the package published. For more information, see "publishConfig" in the npm documentation.

  1. Edit the package.json file for your package and include a publishConfig entry.

    "publishConfig": {
      "registry":"https://npm.pkg.github.com"
    },
  2. Verifica el campo repository en el package.json. de tu proyecto. El campo repository debe coincidir con la URL de tu repositorio de GitHub. Por ejemplo, si la URL de tu repositorio es github.com/my-org/test, entonces el campo de repositorio debe ser git://github.com/my-org/test.git.

  3. Publicar el paquete:

    $ npm publish

Publishing multiple packages to the same repository

To publish multiple packages to the same repository, you can include the URL of the GitHub repository in the repository field of the package.json file for each package.

To ensure the repository's URL is correct, replace REPOSITORY with the name of the repository containing the package you want to publish, and OWNER with the name of the user or organization account on GitHub that owns the repository.

Paquetes de GitHub will match the repository based on the URL, instead of based on the package name. If you store the package.json file outside the root directory of your repository, you can use the directory field to specify the location where Paquetes de GitHub can find the package.json files.

"repository" : {
    "type" : "git",
    "url": "ssh://git@github.com/OWNER/REPOSITORY.git",
    "directory": "packages/name"
  },

Installing a package

You can install packages from Paquetes de GitHub by adding the packages as dependencies in the package.json file for your project. For more information on using a package.json in your project, see "Working with package.json" in the npm documentation.

By default, you can add packages from one organization. For more information, see "Installing packages from other organizations."

You also need to add the .npmrc file to your project so all requests to install packages will go through Paquetes de GitHub. When you route all package requests through Paquetes de GitHub, you can use both scoped and unscoped packages from npmjs.com. For more information, see "npm-scope" in the npm documentation.

  1. Autentícate en Paquetes de GitHub. Para obtener más información, consulta "Autenticar a Paquetes de GitHub."

  2. En el mismo directorio que tu archivo package.json, crea o edita un archivo .npmrc para incluir una línea que especifique la URL de Paquetes de GitHub y el propietario de la cuenta. Reemplaza OWNER con el nombre de la cuenta de usuario u organización a la que pertenezca el repositorio que contiene tu proyecto.

    registry=https://npm.pkg.github.com/OWNER
  3. Agrega el archivo .npmrc al repositorio en donde Paquetes de GitHub pueda encontrar tu proyecto. Para obtener más información, consulta la sección "Agregar un archivo a un repositorio utilizando la línea de comandos".

  4. Configure package.json in your project to use the package you are installing. To add your package dependencies to the package.json file for Paquetes de GitHub, specify the full-scoped package name, such as @my-org/server. For packages from npmjs.com, specify the full name, such as @babel/core or @lodash. For example, this following package.json uses the @octo-org/octo-app package as a dependency.

    {
      "name": "@my-org/server",
      "version": "1.0.0",
      "description": "Server app that uses the @octo-org/octo-app package",
      "main": "index.js",
      "author": "",
      "license": "MIT",
      "dependencies": {
        "@octo-org/octo-app": "1.0.0"
      }
    }
    
  5. Install the package.

    $ npm install

Installing packages from other organizations

By default, you can only use Paquetes de GitHub packages from one organization. If you'd like to route package requests to multiple organizations and users, you can add additional lines to your .npmrc file, replacing OWNER with the name of the user or organization account that owns the repository containing your project. Dado que las letras mayúsculas no son compatibles, debes usar minúscula para el propietario del repositorio si el nombre de usuario o el nombre de la organización de GitHub contiene letras mayúsculas.

registry=https://npm.pkg.github.com/OWNER
@OWNER:registry=npm.pkg.github.com
@OWNER:registry=npm.pkg.github.com

Further reading

¿Te ayudó este documento?

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

O, learn how to contribute.