Package: korbit-mentor
KorbitKorbit mentor CLI will allow you to analyze any local files. See official documentationhereInstallationPipTo install Korbit, you can use pip:pip install korbit-mentorBinaryLinux - MacOSAutomatically installationcurlhttps://mentor-resources.korbit.ai/cli/install.sh|bash
or
sudocurlhttps://mentor-resources.korbit.ai/cli/install.sh|sudobashLinux and Macos x86sudowgethttps://mentor-resources.korbit.ai/cli/latest/korbit-x86_64-O/usr/local/bin/korbit
sudochmod+x/usr/local/bin/korbitMacOS arm64sudowgethttps://mentor-resources.korbit.ai/cli/latest/korbit-aarch64-O/usr/local/bin/korbit
sudochmod+x/usr/local/bin/korbitWindowswgethttps://mentor-resources.korbit.ai/cli/latest/korbit.exe-O~\\korbit.exeUsageTo use Korbit, simply run thekorbitcommand followed by the path of the file or folder you want to zip. For example, to zip the current folder, you can run:korbit scan example/subfolderThis command will take all the files of theexample/subfolderand request a scan on our server.RunFull scankorbitlogin
korbitscanexample/subfolderPR ScanYou can now also analyze only the files that you have been modifying in your current branch to compare to the branch you want.python-mkorbit/clilogin# One ofkorbitscan-pr/path/to/repositorymain
korbitscan-prpath/to/repository
korbitscan-pr# Default use current directory (`.`), as the repository and `origin/master` as the base branchIt will take your current active branch and find the diff files. Using this, it will be requesting a review only on those files.Note: You will be able to use all the same options as thekorbit scanexplained below.Exclude pathsYou have the ability to exclude paths (using.gitignorepath regex format) from being sent to analysis. Use the--exclude-pathsoption on the scan or scan-pr command. It must be a string of regex separated by a comma.korbitscan.--exclude-paths="**/.git/*,**/node_modules/*"# Run the scan-pr command on the current directory against the develop branch without including `.git` and `node_modules` files.korbitscan-pr.develop--exclude-paths="**/.git/*,**/node_modules/*"LimitationTo protect us from large repository upload and potential mistake, we introduced a limit of 100mb for the number of files being sent for analysis. If this happens, make sure you are excluding the large files correctly and the files that you don't need to be reviewed. It will speed up the analysis.OutputWe introduce the ability to run a scan headless, meaning that there will be no output in the terminal. But in the following default path:# In the working directory where the korbit scan command has been executed.cat.korbit/scan.logIf Korbit AI mentor find issues, the command will exit with a specific code number (see--headlessoption documentation).korbitscan--helpThiskorbit scan --headlessflag option will be used mainly in CI/CD pipelines, to automatically stop it.
Along with the --headless command, you can specify certain thresholds for only 2 metrics at the moment:confidence (scale 1-10): represents how confident Korbit AI Mentor is that a particular issue is real. A higher confidence score indicates a greater level of certainty that the identified issue is valid and requires attention.priority (scale 1-10): represents the level of importance or urgency assigned by Korbit AI Mentor to a particular issue. A higher priority score indicates a greater sense of urgency and the need for immediate attention to address the identified issue.korbitscan--headlessNote: You can use the--thresholds-*even if the scan isn't in headless mode, this will filter the issue found and display only the one that matters for you.Progress viewAfter you start to run akorbit scancommand and that our system accepted the request (might take some time regarding load on our server), you will see in your terminal the progress of the scan. Each file will be updated in real time with their status.Analysisinprogress(1/1)├──afile.js⏳
└──afile.py✅
Analyzingfiles(2)...━━━━━━━━━━━━━━━━━━━━╺━━━━━━━━━━━━━━━━━━━50%-:--:--ResultAt the end when every file will be analyzed you will see in your terminal different tables containing the issues' descriptions and their placement in the given file. Along that will see the priority and confidence about that issue.Category:CriticalErrors
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━┓
┃ErrorDescription┃FilePath┃Confidence┃Priority┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━┩
│ThereisanerroronthelineX,because...│folder/afile.js│10│9│
└────────────────────────────────────────────────────┴────────────────────────────┴────────────┴──────────┘ContactIf you have any questions or need further assistance, feel free to reach out to us atsupport@korbit.ai.You can also open new Issue tickets on this repository.