Skip to content
Documentation

Getting Started

Two steps to quantum-secured secrets: install and store. Then wire up your editor in MCP Setup and dive into the 55-command CLI Reference.

Step 1 → 2

Quick start

From npm install to your first stored secret in under a minute.

1Install q-ring

Pick your package manager and install globally:

pnpm
$ pnpm add -g @i4ctime/q-ring
npm
$ npm install -g @i4ctime/q-ring
yarn
$ yarn global add @i4ctime/q-ring
bun
$ bun add -g @i4ctime/q-ring
brew
$ brew install i4ctime/tap/qring

2Store your first secret

Secrets are stored in your OS-native keyring (macOS Keychain, Windows Credential Vault, or Linux Secret Service):

~ / terminal
# Store a secret
$ qring set OPENAI_API_KEY sk-proj-abc123...

# Retrieve it
$ qring get OPENAI_API_KEY
sk-proj-abc123...

# List all stored keys
$ qring list
OPENAI_API_KEY [dev] healthy 0 reads

# Run a health check
$ qring health

Next step: connect your AI editor — configure the MCP server for Cursor, Kiro, Claude Code, or VS Code.

Ready to explore more features?