CIE CLI

The cie CLI is the CredVault Intelligence Engine command-line tool. It gives you complete access to your platform from the terminal — authenticate, manage data, train and deploy ML models, query your database with SQL, monitor live metrics, manage billing, control robots, and chat with Vault AI.

CIE CLI booting in the terminal


Installation

Terminal
npm install -g credvault-cie
What you should seeA completed package install with no dependency errors.

Requires Node.js 18 or higher. Once installed, run cie to see the welcome screen.

What you should see: the terminal should finish without dependency errors. After installation, running cie --version or cie should show the CredVault CLI banner or help screen.


Authentication

Everything starts with logging in.

Terminal
cie login
What you should seeA browser login prompt or terminal confirmation that your CredVault session is active.

You'll be prompted for your email and password. Your session is stored locally and expires after 7 days.

What you should see: the terminal should ask for your CredVault credentials or open the login flow. After success, cie whoami should show your account email and active workspace.

Create an account from the CLI:

Terminal
cie signup

The signup flow walks you through creating your account, accepting terms, and choosing a billing plan — all without leaving the terminal.

What you should see: prompts for account details, plan selection, and confirmation. When signup is complete, the CLI should store your session the same way cie login does.

Check your current session:

Terminal
cie whoami

Configure defaults (cluster, region, environment, API URL):

Terminal
cie configure

Log out:

Terminal
cie logout

Interactive Shell

Instead of typing cie before every command, you can drop into an interactive shell:

Terminal
cie shell

Inside the shell, type commands directly — login, ai, data upload ./file.csv, billing status — and use help to see all available commands grouped by category. Type exit to quit.


Vault AI

Talk to Vault AI directly from your terminal. It understands your platform context — clusters, models, robots — and can suggest fixes, explain errors, and run commands on your behalf.

Start a conversation:

Terminal
cie ai

Ask a single question:

Terminal
cie ai ask "why is my cluster latency high?"

Vault AI streams its response token by token. It supports multi-turn conversations — your session is remembered until you reset it.

Reset the conversation:

Terminal
cie ai reset

Run an AI-powered diagnostic on your entire platform:

Terminal
cie doctor
What you should seeA health report showing your API URL, login state, CLI version, and any missing setup.

The doctor checks the configured API endpoint, local CLI version, Node.js runtime, dependencies, and stored authentication. Use this before debugging a bigger workflow.

What you should see: a health report with pass/fail checks. Failures should tell you what is missing, such as an expired login, wrong API URL, or unsupported Node.js version.


Data Management

Upload a dataset

Terminal
cie data upload ./sales-data.csv

Supports CSV, JSON, and other tabular formats. The CLI shows file size and record count on completion.

What you should see: upload progress, a dataset ID, detected columns, row count, and the next command you can run against that dataset.

List your datasets

Terminal
cie data list

Analyze data quality

Terminal
cie data quality <dataset-id>

Returns completeness, consistency, and validity scores, plus a breakdown of issues by field.

Get a quick quality score

Terminal
cie data quality-score <dataset-id>

Returns a single score (0–100). Green is 80+, yellow is 50–79, red is below 50.

Delete a dataset

Terminal
cie data delete <dataset-id>

Prompts for confirmation. Use --force to skip the prompt.


Model Training

Train a model on a dataset

Terminal
cie train <dataset-id> --name "Churn Predictor" --type classification

Supported model types: classification, regression, clustering, timeseries.

The CLI returns a job ID immediately. Training runs in the background.

Monitor training progress

Terminal
cie jobs status <job-id>

List all your models

Terminal
cie models list

Shows model ID, name, status, accuracy, and training date.

View model details and metrics

Terminal
cie models info <model-id>

Returns accuracy, precision, recall, dataset used, and total predictions made.

Compare two model versions

Terminal
cie models compare <model-id-1> <model-id-2>

View version history

Terminal
cie models versions <model-id>

Roll back to a previous version

Terminal
cie models rollback <model-id> <version>

Export a model

Terminal
cie models export <model-id> --output ./my-model.zip

Predictions

Run a single prediction

Terminal
cie predict <model-id> --data '{"age": 34, "plan": "starter"}'

Or pass input from a file:

Terminal
cie predict <model-id> --file ./input.json

Returns the prediction result and confidence score.

Stream real-time predictions via WebSocket

Terminal
cie stream <model-id>

Opens a live WebSocket connection. Every prediction event is printed as it arrives — result, confidence, and probability breakdown. Press Ctrl+C to stop.


Full ML Pipeline

Run the complete workflow — upload, train, deploy — in one command:

Terminal
cie pipeline run --file ./data.csv --name "Revenue Model" --type regression --env production

If you omit any flags, the CLI prompts you interactively. The pipeline shows each step as it completes:

Code
✓  Dataset uploaded     ds_abc123
✓  Training started     job_xyz789
✓  Training complete    model_def456
✓  Deployed             dep_ghi012
   Endpoint:            https://api.credvault.net/cie/predict/dep_ghi012

Export your pipeline config

Terminal
cie pipeline export > pipeline.json

Dumps all your models and deployments as a JSON config you can version-control or share.


Model Deployment

Deploy a model

Terminal
cie deploy <model-id> --env production

Returns a deployment ID and a live API endpoint.

List all deployment jobs

Terminal
cie jobs list

Check a specific job

Terminal
cie jobs status <job-id>

SQL — LakeVault SQL Engine

Query your database collections using SQL directly from the terminal.

Run a query

Terminal
cie sql "SELECT name, email FROM users WHERE active = true LIMIT 20"

Results are rendered as a formatted table in the terminal.

Interactive SQL REPL

Terminal
cie sql --interactive

Opens a persistent SQL shell. Type queries and press Enter. Type .exit to quit.

Code
sql › SELECT COUNT(*) FROM orders WHERE status = 'completed'
sql › SELECT users.name, SUM(orders.total) FROM users JOIN orders ON users._id = orders.user_id GROUP BY users.name
sql › .exit

API Keys — Test from the CLI

You can test your API keys directly without leaving the terminal. Use cie configure to set your API URL, then any command that hits the backend will use your key automatically.

To test a specific key manually:

Terminal
Test in API explorer
curl -H "Authorization: Bearer <your-api-key>" https://credvault-production.up.railway.app/api/clusters
What you should seeA JSON response, an HTTP status, or a clear authentication or permission error.

Or use the interactive shell to run commands against your live cluster:

Terminal
cie shell
cie> sql "SELECT * FROM your_collection LIMIT 5"
cie> data list
cie> models list

Everything in the shell runs against your authenticated account — same as the dashboard, same as the API.


Webhooks

List webhooks

Terminal
cie webhooks list

Create a webhook

Terminal
cie webhooks create

Prompts for name, target URL, and events to subscribe to (insert, update, delete, replace).

Test a webhook

Terminal
cie webhooks test <webhook-id>

Sends a test event and shows the HTTP status code and response time.

Delete a webhook

Terminal
cie webhooks delete <webhook-id>

Robotics & IoT

Connect to a device

Terminal
cie robot connect <robot-id>

Stream live telemetry

Terminal
cie robot monitor <robot-id>

Opens a WebSocket stream. Prints battery, temperature, CPU, memory, and GPS location as they arrive in real time.

Simulate telemetry (for testing)

Terminal
cie robot simulate <robot-id>

Sends randomized telemetry data every second — useful for testing your dashboard and webhooks without a physical device.

Sync workspace

Terminal
cie pipeline export > pipeline.json

Exports your current CIE workspace configuration. The lower-level workspace sync API exists in the backend, but the public npm CLI does not currently expose a cie robot sync command.


Live Dashboard

Terminal
cie watch

Opens a live terminal dashboard that refreshes every 3 seconds. Shows:

  • Cluster health and system stats
  • Active and recent jobs with progress bars
  • Deployments and their status

Press Ctrl+C to exit. Use --interval <seconds> to change the refresh rate.


Billing

View your plan and current usage

Terminal
cie billing status

Shows your plan, trial days remaining, credits, payment method, per-category spend (storage, requests, bandwidth, compute, AI inference, seats), and projected end-of-month cost.

Get a cost estimate

Terminal
cie billing estimate

List invoices

Terminal
cie billing invoices

View a specific invoice

Terminal
cie billing invoice <invoice-number>

Add or update a payment method

Terminal
cie billing setup

Opens Payments in your browser. Supports card (Visa, Mastercard) and bank transfer via a dedicated virtual account. The CLI polls for confirmation automatically.

Set a monthly spending limit

Terminal
cie billing limit --set 50

Caps your monthly spend at $50. Use --off to disable.

Upgrade your plan

Terminal
cie billing upgrade

Prompts you to choose: Free, Starter ($5/mo), Team ($29/mo), or Pay-as-you-go.

Cancel your subscription

Terminal
cie billing cancel

System & Diagnostics

Check platform health

Terminal
cie doctor
What you should seeA health report showing your API URL, login state, CLI version, and any missing setup.

Run a full diagnostic

Terminal
cie doctor
What you should seeA health report showing your API URL, login state, CLI version, and any missing setup.

View command history

Terminal
cie history

Check for updates

The CLI checks for new versions automatically. Update manually with:

Terminal
npm update -g credvault-cie

Testable API Map

The CLI calls the same CredVault backend as the dashboard. You can test the underlying API routes in /api-docs.

CLI commandBackend route
cie loginPOST /api/auth/signin
cie signupPOST /api/auth/signup
cie whoamiGET /api/auth/me
cie data uploadPOST /api/cie/datasets
cie data listGET /api/cie/datasets
cie trainPOST /api/cie/models/train
cie models listGET /api/cie/models
cie predictPOST /api/cie/predictions
cie deployPOST /api/cie/deployments
cie jobs listGET /api/cie/jobs
cie jobs statusGET /api/cie/jobs/{jobId}
cie sqlPOST /api/cie/sql
cie webhooks listGET /api/webhooks
cie billing statusGET /api/billing/account, GET /api/billing/usage/current

Test a CIE route manually:

Terminal
Test in API explorer
curl https://credvault-production.up.railway.app/api/cie/datasets \
  -H "Authorization: Bearer <your-session-token>"
What you should seeA JSON response, an HTTP status, or a clear authentication or permission error.

If the same route works in /api-docs but fails in the CLI, check cie configure and confirm the API URL is correct.