Skip to content
DataRecs Docs

CLI Overview

The DataRecs CLI (datarecs) lets you manage workspaces, connections, and jobs from your terminal.

Installation

Section titled “Installation”
Terminal window
npm install -g @datarecs/cli

Authentication

Section titled “Authentication”
Terminal window
datarecs login

This opens a browser window for OAuth authentication. Once complete, your session token is stored locally in ~/.datarecs/config.json.

For CI/CD environments, use an API key instead:

Terminal window
export DATARECS_API_KEY=your_api_key_here

Configuration

Section titled “Configuration”

Set your default workspace:

Terminal window
datarecs config set workspace my-workspace

View current config:

Terminal window
datarecs config list

Command structure

Section titled “Command structure”
datarecs <resource> <action> [options]

Resources: workspace, connection, job, config.

Run datarecs --help or datarecs <resource> --help for full usage details.