> 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/developers/cli-install-and-init.md).

# CLI: install & init

Install and configure the qs CLI.

Submit Solidity audits from the command line with `@quillaudits/cli`. The CLI follows the same **quote → order → pay → start** path as the dashboard at [shield.quillaudits.com](https://shield.quillaudits.com/).

{% hint style="info" %}
Requires **Node.js 18+**, a QuillAudits org, and an API key from **Settings → API Keys**.
{% endhint %}

{% stepper %}
{% step %}

### Install

```bash
npm install -g @quillaudits/cli
# or run without installing
npx @quillaudits/cli --help
```

The binary is `qs`.
{% endstep %}

{% step %}

### Create an API key

1. Sign in at [shield.quillaudits.com](https://shield.quillaudits.com/)
2. Open **Settings → API Keys → Create**
3. Copy the `qs_live_…` token (shown once)

API keys are org-scoped and act as **org admin**. Payments bookkeep against an org owner.
{% endstep %}

{% step %}

### Configure

```bash
qs init
```

Prompts for API URL, API key, and optional Org ID. Saves to `~/.quillshield/config.json` (mode `600`).

Default API URL is `http://localhost:3001` for local development. Production:

```bash
https://api.quillaudits.ai
```

{% endstep %}
{% endstepper %}

## Environment variables

For CI (or to override the config file):

```bash
export QUILLSHIELD_API_URL=https://api.quillaudits.ai
export QUILLSHIELD_API_KEY=qs_live_xxxxxxxxxxxx
export QUILLSHIELD_ORG_ID=01ORG…   # optional; API keys are org-bound
```

If both `QUILLSHIELD_API_KEY` and `QUILLSHIELD_API_URL` are set, the config file is skipped.

## Verify

```bash
qs --help
qs wallet
```

`qs credits` is a deprecated alias for `qs wallet`.

Next: [submit an audit](https://www.quillaudits.com/quillshield/developers/cli-submit-and-watch.md).


---

# 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/developers/cli-install-and-init.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.
