CLI tools for Node.js Core collaborators.

• Tools
• Usage
  • Install
  • Setting up credentials
  • Make sure your credentials won't be committed
• Contributing
• License

• get-metadata: Retrieving metadata for a Pull Request.
• git-node: Custom Git commands for working with Node.js core, e.g. landing Pull Requests.
• ncu-config: Configure variables for node-core-utils to use.

npm install -g node-core-utils

If you would prefer to build from the source, install and link:

git clone git@github.com:nodejs/node-core-utils.git
cd node-core-utils
npm install
npm link

Most of the tools need your GitHub credentials to work. You can either

1. Run any of the tools and you will be asked in a prompt to provide your username and password in order to create a personal access token.
2. Or, create a personal access token yourself on GitHub, then set them up using an editor.

If you prefer option 2, follow these instructions to create the token.

Note: We need to read the email of the PR author in order to check if it matches the email of the commit author. This requires checking the box user:email when you create the personal access token (you can edit the permission later as well).

Then create an rc file (~/.ncurc or $XDG_CONFIG_HOME/ncurc):

{
  "username": "your_github_username",
  "token": "token_that_you_created"
}

Note: you could use ncu-config to configure these variables, but it's not recommended to leave your tokens in your command line history.

Put the following entries into ~/.gitignore_global

.ncurc  # node-core-utils configuration file
.ncu    # node-core-utils working directory

Mind that.ncu/land could contain your access token since it contains the serialized configurations.

If you ever accidentally commit your access token on GitHub, you can simply revoke that token and use a new one.

See CONTRIBUTING.md.

MIT. See LICENSE.