> For the complete documentation index, see [llms.txt](https://www.quillaudits.com/quillshield/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.quillaudits.com/quillshield/guides/what-is-quillshield.md).

# What is QuillShield?

What QuillShield is and how the platform works.

**QuillShield by QuillAudits** is an automated smart-contract security platform for **Solidity / Foundry** projects. You upload source or import from GitHub or GitLab.com, get a **USD quote** from scoped billable lines of code (BLOC), pay at checkout (wallet and/or Stripe), and stream findings live. Each audit follows a **workflow**: QuillShield's full audit pipeline by default, a focused official or Marketplace workflow, or one your team builds in plain words in **Workflow Studio**. After a full audit, **CI/CD Checks** run light scans on GitHub pull requests and GitLab.com merge requests.

Product: <https://shield.quillaudits.com/>

## Inside the product

*Projects workspace: create Foundry targets and start checkout.*

![Live audit console](https://1210220531-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRJce4WSdmcKoGJS4NwYy%2Fuploads%2FPKZgquwUUxlrQnPu7Zw6%2Faudit-console.jpg?alt=media)

*Live audit console: progress and severity-graded findings.*

## Platform pieces

| Piece            | Role                                                                                                                                                                                               |
| ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Dashboard**    | Projects, audits, findings, **Workflows**, Ask AI, share links, publish, **CI/CD Checks**, **Billing**, Team, Support                                                                              |
| **Checkout**     | Quote → order → pay (prepaid / refund / bonus plus Stripe card or crypto). New accounts get **$50** signup credit (50% cap).                                                                       |
| **Workflows**    | The plan each audit follows: the QuillShield Audit Agent (default), official and Marketplace workflows, or your own, built in Workflow Studio with an AI assistant. Same price for every workflow. |
| **Control API**  | REST `/v1`: auth, projects, quotes/orders, audits, wallet, CI scans, shares, publish                                                                                                               |
| **CLI and MCP**  | `@quillaudits/cli` (`qs`) and `@quillaudits/mcp` for Cursor/Claude                                                                                                                                 |
| **GitHub App**   | Optional PR/commit automation with Checks                                                                                                                                                          |
| **GitLab.com**   | Sign-in, private import, and merge-request / commit scans via a project webhook                                                                                                                    |
| **Audit engine** | Managed background analysis (platform-operated)                                                                                                                                                    |

```mermaid
flowchart TB
  UI[Dashboard / CLI / MCP / GitHub / GitLab] --> API[Control API]
  API --> Pay[Quote / Order / Wallet]
  Pay --> Job[Audit job or CI scan]
  Job --> Results[Findings, report, Ask AI]
```

## Typical journey

{% stepper %}
{% step %}
**Create an account** at [shield.quillaudits.com](https://shield.quillaudits.com/) with email and 2FA, or Continue with Google, GitHub, or GitLab.
{% endstep %}

{% step %}
**Create a project** (GitHub, GitLab.com, git URL, zip, folder, or `.sol`), select scope, optionally attach docs, and keep the default workflow or choose another one.
{% endstep %}

{% step %}
**Review the USD quote** (from **$49**, curve `charm(max(49, 3 × L^0.7))`), apply coupon/wallet if any, and pay cash due on Stripe if needed.
{% endstep %}

{% step %}
**Watch live progress**, triage findings, Ask AI, download the markdown or PDF report, share a read-only link, or publish to the leaderboard.
{% endstep %}

{% step %}
**Turn on CI/CD Checks** after the first full audit on a GitHub or GitLab.com project.
{% endstep %}
{% endstepper %}

## Next

* Quickstart
* Using the dashboard
* Pricing and top-up
* Core concepts
* [Workflows](https://www.quillaudits.com/quillshield/guides/guides/workflows.md)
* [Developers](https://www.quillaudits.com/quillshield/developers/)


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://www.quillaudits.com/quillshield/guides/what-is-quillshield.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
