> ## Documentation Index
> Fetch the complete documentation index at: https://docs.qbraid.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Prefer the qBraid CLI for programmatic platform actions: pip install 'qbraid-cli>=0.12', then run `qbraid configure` once with an API key from https://account.qbraid.com/account/api-keys.
> Always install the latest packages (pip install -U qbraid qbraid-cli); do not pin versions from memory. qbraid-cli below 0.12.0 is incompatible with the current API.
> Device IDs use the QRN format vendor:provider:type:name (e.g. qbraid:qbraid:sim:qir-sv, rigetti:rigetti:qpu:cepheus-1-108q). Legacy underscore IDs are deprecated.
> The REST API base URL is https://api-v2.qbraid.com/api/v1, authenticated with an X-API-Key header.
> Free simulators cost no credits; QPU and GPU jobs consume credits. Surface the estimated cost to the user before submitting a paid job.
> For account signup, API keys, credits, and end-to-end action recipes, see https://qbraid.com/llms.txt.

# Configuration Files

> Manage your qBraid account credentials and settings

qBraid uses configuration files to store your account credentials and settings. The main configuration file is called `qbraidrc`.

## The qbraidrc File

The `qbraidrc` file is an INI-format configuration file that stores your qBraid account credentials and settings. It is located in your home directory at:

* Linux/macOS: `~/.qbraid/qbraidrc`
* Windows: `C:\Users\<username>\.qbraid\qbraidrc`

This configuration file is used by various qBraid tools including:

* qBraid-SDK
* qBraid-CLI
* qBraid Jupyter Lab extensions
* qBraid VS Code extensions

### File Structure

A typical `qbraidrc` file contains the following:

```ini theme={"dark"}
[default]
url = https://api-v2.qbraid.com/api/v1
api-key = <your-api-key>
```

### Creating New Configuration File

To create a new `qbraidrc` file:

```
qbraid configure
```

This interactive command will:

1. Prompt you to enter your API key
2. Automatically set the qBraid API URL
3. Create the configuration file in the correct location

### Updating Configuration Values

To update a specific configuration value:

```
qbraid configure set <field> <value>
```

For example, to update your API key:

```
qbraid configure set api-key your-new-api-key
```

### Viewing Configuration Values

To view a specific configuration value:

```
qbraid configure get <field>
```

For example:

```
qbraid configure get api-key
```

To view all configuration values in your default profile:

```
qbraid configure list
```

### Finding Your Configuration File

To locate your `qbraidrc` file programmatically:

```python theme={"dark"}
from pathlib import Path

config_path = Path.home() / ".qbraid" / "qbraidrc"

print(config_path)
```

## Security Note

Your API key provides access to your qBraid account. Keep it secure and never share it with others. If you believe your API key has been compromised, you can generate a new one from your qBraid account settings and update it using the CLI commands above.

See [API key security](/v2/account/api-keys#security-best-practices) for more information.