codemate-cli v0.0.11
Table of Contents
Getting Started
Prerequisites
The system should have Node.js
runtime and npm
installed and configured to run the application.
Usage
- Install the package globally using
npm install -g codemate-cli
- Run
codemate
to see all the available commands - Run
codemate <command> --help
to see the usage of the command
Available Commands
codemate login
Login to CodeMate AI
codemate github
Link your GitHub account with CodeMate AI for importing private repos to your KB
codemate add-KB
- Add current local codebase
- Add a GitHub repo
- Add a website's content
codemate chat <query>
- Chat with CodeMate AI. Users can ask any query related to their codebase and CodeMate will answer them. Users have further options:
- Select what projects they want to refer while asking questions(from projects already added to thier knowledge base) Max 2 projects
- Attach a file to their query
Option to enable web browsing to enable real time and up-to-date answers (Takes longer time for answering queries)
<br>
codemate review
Review your codebase. CodeMate will review your codebase and give you suggestions to improve your code quality. (Scans for limited and only relevant files)
codemate debug <file>
codemate review <file>
codemate optimise <file>
codemate monitor <process>
[![Demo](https://s5.gifyu.com/images/Si0a4.gif)](https://s5.gifyu.com/images/Si0a4.gif)<br>
\
codemate set-theme <theme>
Set a valid RGB color code as your theme color. CodeMate will use this color as your theme color in the chat window. (Default color is #48AEF3)
codemate logout
Logout from CodeMate AI
License
This project is licensed under the MIT License - see the LICENSE file for details.