Getting Started with CredVault

By the end of this page you will have an account, a cluster, an API key, and (optionally) CIE installed.

1. Create your account

Open Sign up. Register with email, or continue with Google or GitHub.

After you land in the dashboard, the left sidebar is your map of the product: clusters, workspace tools, monitoring, billing, and settings.

2. Your workspace

Every account sits in a workspace that holds:

• Database clusters — where collections and documents live
• API keys — programmatic access (X-API-Key)
• Team access — invite people and manage roles (Team Management)
• Billing — plan, usage, invoices

3. Create your first cluster

1. Go to Clusters.
2. Click Create Cluster.
3. Set a clear name (for example dev-main or production).
4. Pick region and tier for your workload (start small; you can scale later).
5. Create and wait until status is healthy.

From the cluster page you can open schema, rules, triggers, functions, webhooks, backups, scaling, and maintenance.

4. Create an API key

1. Open API Keys (not buried only under Settings).
2. Click Create key.
3. Name it for the app or environment (backend-dev, ci-pipeline).
4. Choose environment: production, staging, or development.
5. Copy the secret immediately — it is shown once.

Use the key as X-API-Key against /api/v1/data/<collection> (requests use the workspace’s active cluster). Details: API Keys.

5. Connect how you work

Dashboard

Browse and manage data from the cluster UI without writing client code.

CIE (terminal)

curl -fsSL https://credvault.net/install/cie | sh

cie login
cie whoami
cie doctor

Full command map: CIE CLI.

SDKs

Official packages ship as CredVault artifacts (credvault-edge and language variants). Install from the artifacts or source under SDKs — do not assume every language is already on public npm/PyPI/Maven/Go proxies.

Pragma IDE

For a native desktop ADE (terminal, editor, AI agent, Drive): Download and Pragma overview.

6. Store data

CredVault uses a document model: clusters → databases → collections → JSON-like documents. Collections appear when you first insert. Add schema and access rules when you need stronger guarantees.

Explore next

In the dashboard sidebar (no separate docs pages): Notebook, ML Experiments, Orchestration, Lineage, Metadata, Omnigent, Team Management — open them after sign-in.

Continue with Core Concepts.