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

# How it works

## 1. Create account

create a new account with just login with your github hosting provider Github, Bitbucket or Gitlab.

## 2. Connect the repository you want

Once you connect your repository Shieldfy do initial scan and put some kind of webhook to get notified automatically every time you make a change on your code.

![](/files/-MCw-bdIW2KWuWhUQpqa)

## a. Write code, commit and push 

Write your code as you are used to do and push it to your git hosting provider.

## b. The Git provider will notify Shieldfy about the push.

Your git hosting provider will send a webhook to Shieldfy to let us know about your push. Shieldfy supports all major GIT hosting (Github, Bitbucket and Gitlab).

## c. Shieldfy will clone your repository in Isolated container and start analysis

Shieldfy automatically spinning up docker container bundled with our analyzer and clone your code inside the isolated container and start the analysis. The container is removed after the analysis.

## d. Shieldfy will report back to the git provider CI with the result as well your email

You will see the result directly into your GIT CI so you can act on it, and you will get notified by email too.

![](/files/-MCw-PadoYSneqO6zktG)

## e. You can access the result any time via Shieldfy dashboard

Any time you can access your dashboard at Shieldfy, you will see all information regarding your repositories security according to your data retention plan.


---

# 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.shieldfy.io/introduction/untitled.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.