Installing qBits

Add qBits to your qqq application using the qctl CLI or manual Maven configuration.

Using qctl (Recommended)

The easiest way to install qBits is using the qctl CLI. It handles dependency resolution, configuration scaffolding, and version compatibility automatically.

Bash

# Install a qBit
qctl qbit add auth-jwt

# Install multiple qBits
qctl qbit add postgres-backend s3-storage

# Install a specific version
qctl qbit add stripe-integration@3

After installation, qctl will prompt you to configure the qBit with any required settings like API keys or connection strings.

Query says

Always pin your qBit versions in production. Use qctl qbit lock to generate a lockfile that ensures consistent versions across your team.

Manual Installation (Maven)

Query warns

Manual installation skips compatibility checks. Make sure your qBit version matches your qqq core version to avoid runtime errors.

You can also add qBits manually by adding the Maven dependency to your pom.xml:

XML

<dependency>
    <groupId>io.qrun.qbits</groupId>
    <artifactId>qbit-auth-jwt</artifactId>
    <version>1.0.3</version>
</dependency>

Then register the qBit in your application's QInstance configuration.

Listing Installed qBits

Bash

# List all installed qBits
qctl qbit list

# Check for updates
qctl qbit outdated

Removing qBits

Bash

# Remove a qBit
qctl qbit remove auth-jwt

# Remove and clean up configuration
qctl qbit remove auth-jwt --clean

Query notes

The --clean flag removes configuration files but preserves any database tables created by the qBit. Use migrations to handle schema cleanup.

Next Steps

Configure qBits Browse qBits Catalog