Quick Start Guide

The quickest way to run your first code audit is through a Google Colab notebook that will push your repository to CodeAudits.ai, where you can then review audits for your codebase.

Try it on your own here: Code Audits - Quickstart Guide

Step by Step

This flow requires no additional setup (if you want to push a private repository, you must use your GitHub Access Token).

1. Open the Colab notebook linked above.
2. Google Colab clones your repository.
3. The repository is parsed and submitted to CodeAudits.ai.
4. After submission, you can review the audits generated for your code.

You can see example audits here.

Who Should Use It?

• If you have a public repository on GitHub (or you don’t mind submitting a private one).
• If you want to check out CodeAudits.ai in under five minutes.
• If you’re okay with using the free-of-charge Google Gemini API (your submitted data may be used to train Google’s models).

Alternative Ways to Try Code Audits

There are several ways to generate code audits. Each method starts with the codebase-dump app, a Python open-source project that parses your codebase and uploads it to CodeAudits.ai.

Here’s how you can use it:

• Run it locally on your machine: The app is available on PyPI. Read the Readme file for more details.
• Run it as a GitHub Action: See this example workflow. Here is an example output.
• Run it from the source code: Instructions are also described in the project’s Readme file.
• Run it in Colab: Use an online Python notebook. Launch it here: Code Audits - Quickstart Guide. To test it out, run all the code via Runtime -> Run All.

Set Up Your Gemini API Key

By default, the app uses a free-to-use API key for the Gemini API. However, it’s likely this key will expire or its limits will be exceeded eventually.

If you want to keep using the Code Audits app, you can set up your own Gemini API key, which will be stored in your browser’s session.

To quickly generate a Gemini API key, visit: https://aistudio.google.com/.