> For the complete documentation index, see [llms.txt](https://typo.gitbook.io/typo-help-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://typo.gitbook.io/typo-help-docs/platform/settings-and-admin/code-health-configuration/code-health.md).

# Code Health

Follow these steps to get started with the Code Health module -

### Step 1: Get Started

Navigate to the Code Health module on your dashboard after onboarding your Git account with Typo. Click the Get Started button.

<div align="left"><figure><img src="/files/TqaPUQ8j8l52iVC4og5z" alt=""><figcaption></figcaption></figure></div>

### Step 2: Grant Permissions to Your GitHub Repos

Update the required permissions. &#x20;

<div align="left"><figure><img src="/files/ot1ExhWqIiYOY7iKIbf0" alt="" width="563"><figcaption></figcaption></figure></div>

Know more about [permissions here](/typo-help-docs/faqs/data-security-and-privacy/github-app-permissions-details.md)

> Admin access to your GitHub account is needed to complete this step.

{% hint style="info" %}
🚀 Note: We do not store your code. We only save code snippets where issues are detected to display them and provide auto-fix suggestions.
{% endhint %}

### **Step 3:** Repo Analysis

Once permissions are granted, your repo will be analyzed. Detected issues will appear on your dashboard based on the configured rules.<br>

[How to add a configuration file for Code Health](/typo-help-docs/faqs/metrics-faq/how-to-add-a-configuration-file-for-code-health.md)\
[How to Configure Typo Code Health Checks to Block a PR Merge in Git](/typo-help-docs/faqs/metrics-faq/how-to-configure-typo-code-health-checks-to-block-a-pr-merge-in-git.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://typo.gitbook.io/typo-help-docs/platform/settings-and-admin/code-health-configuration/code-health.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.