Qalá LogoQaláv0.9.0
Back to Documentation

Quick Start Guide

Get up and running with Qalá in minutes. This guide walks you through installation, initial setup, and your first secret management tasks.

Installation


CLI Installation

# Install the CLI globally
npm install -g qala
# Verify installation
qala --version

Node.js Integration

# Add to your project
npm install qala --save
# TypeScript definitions included


Initial Setup


1. Create an Account

Sign up at app.qala-security.com or set up a self-hosted instance.


2. Generate API Key

# Generate via CLI if self-hosted
qala auth generate-key --name "Development Key"
# Or generate in web dashboard:
# Settings → API Keys → Generate New Key

Save your API key securely - it will only be shown once.


3. Initialize Your Project

# Interactive setup
qala init
# Non-interactive setup
qala init --project-name "My Project" --env development

This creates a .qala.json configuration file in your project directory.

Managing Secrets


Adding Secrets

# Add a single secret
qala secret add DATABASE_URL --value "postgresql://user:password@localhost:5432/db"
# Add multiple secrets from a file
qala secret import --file ./secrets.json
# Generate a secure random value
qala secret generate API_KEY --length 32

Retrieving Secrets

# Get a specific secret
qala secret get DATABASE_URL
# List all secret names (without values)
qala secret list
# Export to .env format
qala secret export > .env.production

Updating Secrets

# Update an existing secret
qala secret update DATABASE_URL --value "postgresql://user:password@newhost:5432/db"
# Update with editor
qala secret edit DATABASE_URL

Deleting Secrets

# Remove a secret
qala secret remove DATABASE_URL
# Remove multiple secrets
qala secret remove API_KEY JWT_SECRET

Using Secrets in Applications


Node.js Applications

const { QalaClient } = require('qala');

// Initialize client
const qala = new QalaClient();

async function main() {
  // Authenticate (using API key from env or config file)
  await qala.authenticate();

  // Get a secret
  const dbUrl = await qala.getSecret('DATABASE_URL');

  // Use the secret
  const db = connect(dbUrl);
}

main().catch(console.error);

Running Applications with Secrets

# Inject secrets as environment variables
qala run -- node server.js
# Or with npm scripts
qala run -- npm start

Working with Environments

# Switch environment
qala env use production
# Add a secret to a specific environment
qala secret add API_KEY --value "prod-key" --env production
# Compare environments
qala env diff development production

Collaborating with Teams

# Invite team member (Team plan+)
qala team invite team@example.com
# Share specific secrets
qala secret share DATABASE_URL --with user@example.com
# View access history
qala audit list --secret DATABASE_URL

Next Steps


Troubleshooting

If you encounter issues:

  • * Check the .qala.json configuration file
  • * Ensure your API key has the necessary permissions
  • * Run qala doctor to diagnose common problems
  • * Visit our community forum for help

For additional assistance, contact support@qala-security.com.