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 extension
File Structure
A typical qbraidrc
file contains the following:
Creating New Configuration File
To create a new qbraidrc
file:
This interactive command will:
- Prompt you to enter your API key
- Automatically set the qBraid API URL
- Create the configuration file in the correct location
Updating Configuration Values
To update a specific configuration value:
For example, to update your API key:
Viewing Configuration Values
To view a specific configuration value:
For example:
To view all configuration values in your default profile:
Finding Your Configuration File
To locate your qbraidrc
file programmatically:
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 for more information.