Skip to main content

​
Installation

The MatterAI CLI is a command line tool that allows you to locally generate PR Description and Checklist. Official Link: https://www.npmjs.com/package/matter-ai-cli
1

Install the MatterAI CLI from NPM

npm install -g matter-ai
2

Generate a new Github Personal Access Token (Classic)

Generate a new Github Personal Access Token here https://github.com/settings/tokens with the following permissions:
MatterAI Github Connect
3

Run the CLI

  1. Go to the directory of the repository you want to analyze.
  2. Run the CLI with the following command:
matter
  1. Enter the Github Personal Access Token when prompted.
4

Select the Pull Request

Select the Pull Request you want to analyze from the list of Pull Requests.
MatterAI Github Connect
5

Select the AI Summary Generation

Select the AI Summary option from the list of options.
MatterAI Github Connect
6

Enter OpenAI API Key

Enter the OpenAI API Key when prompted. Or you can set the OPENAI_API_KEY environment variable.
MatterAI Github Connect
7

Your AI Generated Summary is Ready

Your AI Generated Summary is ready in markdown format!
MatterAI Github Connect

​
Pro Features

The CLI is free to use, but you can upgrade to the Pro version to get more features:
  1. Automatic AI Summary Generation on every PR and commits
  2. AI Code Review on every PR and commits
  3. AI Explanation on every PR and commits
  4. Team-level analytics and insights
You can get started by visiting https://matterai.so