> 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/getting-started/quickstart.md).

# Quickstart

Sign up, get a quote, pay, and run your first audit.

Get from zero to a completed audit on [shield.quillaudits.com](https://shield.quillaudits.com/).

{% stepper %}
{% step %}

### Create your account

1. Open [shield.quillaudits.com](https://shield.quillaudits.com/).
2. Register with email and password, or **Continue with Google**, **GitHub**, or **GitLab**. Accept the Terms of Service.
3. Email sign-up completes **2FA** with the code sent to your inbox. Google, GitHub, and GitLab sign-in open a session directly.

New accounts receive **$50** signup credit once. It is promotional bonus credit: it covers at most **50%** of a post-coupon order and expires **6 months** after grant. You still pay the rest of the quoted price (from **$49**) with prepaid dollars, a referral or coupon, or Stripe.
{% endstep %}

{% step %}

### Optional: top up prepaid dollars

Open **Billing** to add prepaid dollars via Stripe (card or crypto) if you want balance ready before checkout. You can also pay the full audit price at checkout without a prior top-up.
{% endstep %}

{% step %}

### Create a project and set scope

From **Projects → New project**, choose GitHub, GitLab.com, a git URL, a `.zip`, a folder, or a single `.sol` file. Then select which Solidity files are in scope and optionally attach docs. The platform computes **BLOC** for pricing.
{% endstep %}

{% step %}

### Get a quote and check out

1. Continue to **Review & pay**.
2. Review the USD **quote** (scope-curve price from BLOC, `QS-PAYG-USD-V6`). Checkout always runs the **full audit pipeline** with proof-of-concept exploits.
3. Pay any **cash due** with Stripe (card or crypto), or cover it fully with wallet balance.
4. When the order is **paid**, the audit job starts automatically.

![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)
{% endstep %}

{% step %}

### Review results

Browse findings by severity, update triage status, Ask AI, optionally **Share** a read-only link or **Publish** to the QuillAudits leaderboard and a public report, and download the markdown or PDF report.

{% hint style="warning" %}
If the audit fails, check the job details in the UI. Paid value may be returned as **refund credits** in your wallet for reuse at checkout.
{% endhint %}
{% endstep %}
{% endstepper %}

## Next

* Protect pull requests and GitLab.com merge requests with CI/CD Checks after the first full audit.
* Share a Refer & Earn code. Friends get $20 off their first paid audit.
* Invite teammates from **Team**.

## Prefer the CLI or Cursor?

```bash
npm install -g @quillaudits/cli
qs init
qs audit https://github.com/org/contract --ref main --yes --watch
```

See [CLI: install and init](https://www.quillaudits.com/quillshield/developers/cli-install-and-init) or [MCP for Cursor and Claude](https://www.quillaudits.com/quillshield/developers/mcp-for-cursor-and-claude).


---

# 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/getting-started/quickstart.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.