> For the complete documentation index, see [llms.txt](https://docs.threatrix.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.threatrix.io/developer-quickstart.md).

# Developer Quick Start

### 1) Create an account

The easiest way to scan your project is by authenticating using Github or Gitlab. [OAuth login](/threat-center-1/creating-account/oauth-login.md). This enables you to have immediate access to your projects.

Alternatively, you can scan your project using our [Threat Agent](/threat-agent/threat-agent-1.md).

### 2) Scan your project using ThreatScan

Once you've authenticated using OAuth, you will access your repositories from within our [ThreatScan dashboard](/securecore/threatscan.md). 

### 3) Reviewing scan results

Scan status will be available in the lower right-hand corner of your screen. 

![](/files/-MiSWJULV2L_-B8uZcyN)

Once the scan has been completed, a link to the [scan results](/securecore/scan-results.md) will appear in the status bar for up to 20 seconds. 

![](/files/-MiSWkgU7LstCpx2H-G-)

Completed scan results will also be available from within the [Entity](/resources/dictionary.md#entity) dashboard. That's typically, but not always, your default Entity, which can be reached by clicking "My Team" on the top menu bar and then clicking the "Projects" tab. 

![](/files/-MixEhVTjk3OrCcvQp6M)

{% hint style="info" %}
For more information, see our full documentation on reviewing [scan results](/securecore/scan-results.md).
{% endhint %}


---

# 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://docs.threatrix.io/developer-quickstart.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.