Run your first smart contract audit, from sign-up to report
To run your first QuillShield audit, sign up, create a project from your Solidity repository or a zip, choose the files in scope, check the quote and pay. The audit starts when the order is paid. Findings appear while it runs, and the finished report downloads as Markdown or PDF.
When you finish this guide you will have a completed full audit of your Solidity project in QuillShield, with findings grouped by severity, a status your team sets on each one, and a report to download or share. The QuillShield docs give no fixed time for an audit. The demo vault on the QuillShield home page took 2h 7m, and larger codebases take longer.
What do you need before your first audit?
- A Solidity project built with Foundry. That is what QuillShield supports today.
- The code as a GitHub or GitLab.com repository, a git URL, a Foundry
.zipof up to 50 MiB, a folder, or a single.solfile. Use a GitHub or GitLab.com repository if you want pull request checks later, because an upload gets a full audit and no checks. - A way to pay the quote through Stripe Checkout. New accounts get $50 in credit, good for up to half of an order, and it expires after six months.
- The admin or owner role, if you are joining an existing organization, because only those roles create projects.
How do you run a full audit in QuillShield?
- 1 Create your account. Open the sign-up page. Register with email and password, or choose one of the Continue with buttons shown, for Google, GitHub or GitLab, and accept the Terms of Service. Email sign-up ends with a 2FA code sent to your inbox.
- 2 Start a project. Open Projects, click New project and pick a source tab: GitHub, GitLab.com, Git URL or Zip / folder / .sol. For GitHub or GitLab.com, connect the account under Integrations in Settings first, unless you signed in with it. Then pick the repository and a branch, tag or commit.
- 3 Choose the scope. On Scope, select the
.solfiles to audit. Tests,lib/, mocks, scripts and generated folders are left out by default. Click Save & continue. - 4 Attach documents, or skip. On Docs, upload PDF or Markdown, paste text or import a public URL. The limits are 24 files, 10 MiB each, 40 MiB in total and 80 PDF pages. Click Continue, or Skip.
- 5 Keep the default workflow. If your workspace shows a Workflow step, leave the QuillShield Audit Agent selected and click Save & continue. Workspaces without workflows do not have this step.
- 6 Review and pay. On the last step, Review & pay, check the quote, which shows the exact price before anything is charged. Your credit and any wallet balance are applied first, and the rest is paid through Stripe Checkout. The audit starts by itself when the order is paid.
- 7 Watch it run. The audit page streams status and findings as the job moves through Preparing, Mapping, Modeling, Consolidating and Finalizing. Cancel works while the job is queued, building or running.
- 8 Read the results. Open Audits and select the job. Mark each finding as open, acknowledged, fixed or false positive, then download the Report (Markdown / PDF / JSON).
From a terminal, three commands do the same. qs init asks for the API URL, which is https://api.quillaudits.ai, and an API key from API keys in Settings. Without --yes, qs audit asks you to confirm the charge. Add --yes only in CI, where it skips that question.
npm install -g @quillaudits/cli
qs init
qs audit https://github.com/org/contract --ref main --watch
What does a finished audit include?
- Findings grouped by severity, from critical to info, each with a title, a description, the impact and the code locations.
- Proof of concept (PoC) results. A full audit may include a PoC status on a finding (none, pending, passed or failed) and a PoC bundle to download.
- The report in Markdown or PDF, and Artifacts, which may include
recon.mdandinvariants.md. - Ask AI, a chat that answers from the saved findings without re-running the audit.
- Share, a read-only public link to the findings and report with no PoCs or source code, and Publish, which lists the audit on the QuillAudits leaderboard, as a public report, or both. Neither happens unless you choose it.
- Verify findings with expert, a form that asks a QuillAudits auditor to check specific findings.
On a git project, this audit is also the baseline for pull request checks, and it comes with five. Next, check every pull request on GitHub.
Common problems when starting an audit
| What you see | Why | What to do |
|---|---|---|
| Checkout says payment is required | An amount is still due on the order | Finish Stripe Checkout, or add prepaid balance under Billing and retry. The sign-up credit covers up to half of an order |
| A private repository will not import | QuillShield has no access to it | Connect your GitHub or GitLab.com account under Integrations in Settings, or install the GitHub App |
scope_changed |
The scope was edited after an unpaid order | Save the scope again and get a fresh quote |
| Audit failed | The project could not be analyzed as submitted | Read the job error on the audit page, fix the source and start a new audit |
Full reference in the QuillShield docs
The Quickstart in the QuillShield docs covers the same steps. Run an audit and Review findings go further on checkout and triage.
Common questions
How long does a QuillShield audit take?
The docs give no fixed time. The demo vault on the QuillShield home page took 2h 7m, and larger codebases take longer. Findings appear while the audit runs.
Which languages does QuillShield support?
Solidity is supported today, for Foundry projects.
When do I pay for an audit?
You see the exact price before anything is charged, and the audit starts when the order is paid. New accounts get $50 in credit, good for up to half of an order, and it expires after six months.
Can I audit a zip instead of a repository?
Yes. You can upload a Foundry zip of up to 50 MiB, a folder or a single .sol file. An upload gets a full audit and no pull request checks, because checks need a GitHub or GitLab.com repository.
Sources
- Quickstart, QuillShield docs
- What is QuillShield?, QuillShield docs
- Account and security, QuillShield docs
- Create a project, QuillShield docs
- Scope and documentation, QuillShield docs
- Use a workflow in an audit, QuillShield docs
- Run an audit, QuillShield docs
- Review findings, QuillShield docs
- Ask AI about findings, QuillShield docs
- Share an audit, QuillShield docs
- Expert review and support, QuillShield docs
- CLI install and init, QuillShield docs
- CLI submit and watch, QuillShield docs
- Troubleshooting, QuillShield docs