Welcome to CredVault
CredVault is the control plane for your data platform and developer platform. It brings together managed database clusters, API access, automation, AI workflows, cloud development environments, and Pragma IDE downloads in one product surface.
The goal is simple: a user should be able to sign in, create a secure data workspace, connect an application, automate work around the data, and build from the browser, terminal, or desktop IDE without stitching together many separate tools.
Product Map
| Area | What users do | Where it lives |
|---|---|---|
| Database platform | Create clusters, collections, documents, rules, backups, scaling, and maintenance windows | Dashboard -> Clusters |
| API platform | Create API keys, call REST endpoints, manage scopes, test requests | Dashboard -> API Keys and /api-docs |
| CIE | Upload datasets, train models, deploy models, run SQL, use terminal workflows | cie CLI and /api/cie |
| Automation | Run functions, triggers, webhooks, pipelines, migrations, and scheduled workflows | Cluster actions, Functions, Webhooks, Migrations |
| Observability | View metrics, activity logs, alerts, dashboards, service health, and usage | Monitoring, Logs, Billing |
| Data tools | Use notebooks, ML experiments, orchestration, lineage, metadata, and visualization tools | CredVault notebooks, experiments, orchestration, lineage, metadata, and realtime visualization |
| Developer tools | Open Coder cloud workspaces and install Pragma IDE | Coder and Download pages |
How The Platform Fits Together
Most user workflows follow the same path:
- A user signs in through CredVault authentication.
- CredVault creates or finds the user's tenant/workspace.
- The user creates a database cluster.
- The backend stores cluster metadata and provisions access.
- The user creates an API key or uses a session token.
- Applications, SDKs, the dashboard, and the
cieCLI call the same backend APIs. - Activity logs, billing usage, and security checks run around those requests.
That means the dashboard and CLI are not separate products. They are two ways to control the same CredVault backend.
What Users Can Build
Database Applications
Use CredVault like a managed document database. Create collections, insert JSON documents, query data, apply access rules, and expose controlled access through API keys.
Test it from the API explorer:
Open /api-docs
Authorize with a Bearer token or API key
Try GET /api/clusters
Try GET /api/data/clusters/{clusterId}/collections
Automation Around Data
Use functions and webhooks to react when something changes. A common flow is:
Document inserted -> webhook delivery -> external system receives event
Document inserted -> trigger/function -> custom backend logic runs
Pipeline scheduled -> data transformed -> logs recorded
AI And ML Workflows
Use CIE from the terminal:
npm install -g credvault-cie
cie login
cie data upload ./customers.csv
cie train <dataset-id> --name "Churn Model" --type classification
cie jobs status <job-id>
Developer Workspaces
Use Coder when a developer needs a browser-accessible development environment with terminal access, workspace templates, and IDE integrations. Use Pragma when a user wants the desktop IDE experience.
What Is Actually User-Facing
The documentation in this section focuses on things a user can directly see or use:
- Dashboard pages such as Clusters, API Keys, Billing, Logs, Monitoring, Migrations, and Downloads
- CLI commands such as
cie login,cie data upload,cie jobs status, andcie billing status - REST APIs available through the backend and
/api-docs - Integrated tools such as Coder, Pragma, experiments, orchestration, lineage, metadata, and realtime visualization
When a feature depends on an external service being configured, the docs call that out. For example, experiments, orchestration, lineage, metadata, realtime visualization, and robotics integrations rely on service URLs and proxy routes being available in the backend.
Start Here
- Create an account at Sign up.
- Open the dashboard and create a database cluster.
- Create an API key from API Keys.
- Open REST API and test an endpoint in
/api-docs. - Install the CIE CLI with
npm install -g credvault-cie. - Read Database Clusters, API Keys, and CIE CLI.
For Developers
Use these paths when you want to test from your machine:
# Install the terminal tool
npm install -g credvault-cie
# Log in to CredVault
cie login
# Check your account
cie whoami
# Test platform health
cie doctor
Use these paths when you want to test from the browser:
/api-docs Interactive API explorer
/cluster Database clusters
/api-keys API key management
/logs Activity logs
/billing Plan, usage, invoices, and payment methods
/download Pragma IDE installers
Documentation Standards
Every strong CredVault doc should answer four questions:
- What does the feature do?
- Where does the user click?
- What API or CLI command is behind it?
- How can the user test that it works?
The next pages follow that structure.