Replica CLI

Command-line tool for generating and exporting Salesforce test data.

Installation

For Beta Testers (from GitHub)

# Clone the repo
git clone https://github.com/datakarma/replica.git
cd replica/packages/cli

# Install dependencies and build
npm install
npm run build

# Link globally
npm link

# Verify installation
replica --help

From npm (coming soon)

npm install -g @datakarma/replica-cli

Using npx (coming soon)

npx @datakarma/replica-cli <command>

Quick Start

1. Get an API key from replica.datakarma.ai/settings/api-keys

2. Authenticate:

   replica login

3. Generate data:

   # Generate with a template
   replica generate --template saas-startup --accounts 100
   
   # Generate and push to Salesforce
   replica generate --template saas-startup --push

4. Export data:

   replica export --format csv --output ./data

Commands

replica login

Authenticate with your API key.

replica login                    # Interactive prompt
replica login --key rpl_xxx      # Non-interactive
replica login --logout           # Clear credentials

replica generate

Generate test data.

# Use a template
replica generate --template saas-startup

# Custom configuration
replica generate --accounts 200 --campaigns 20

# Generate and push directly
replica generate --template enterprise-b2b --push --connection my-sandbox

# Interactive mode
replica generate --interactive

Options:

• -t, --template <slug> - Use a template
• -a, --accounts <n> - Number of accounts
• -c, --campaigns <n> - Number of campaigns
• -l, --leads <n> - Number of leads
• --activities - Include tasks and events
• --products - Include products and quotes
• -m, --months-back <n> - Months of historical data
• -q, --quality <percent> - Data quality (0-100)
• -p, --push - Push to Salesforce
• --connection <id> - Salesforce connection ID
• -i, --interactive - Interactive prompts

replica export

Export generated data to files.

replica export                           # Export last preview as CSV
replica export --format json             # Export as JSON
replica export --output ./my-data        # Custom output directory
replica export --objects accounts,contacts  # Export specific objects

Options:

• -p, --preview <id> - Preview ID to export
• -f, --format <type> - json or csv (default: csv)
• -o, --output <dir> - Output directory
• --objects <list> - Comma-separated object list

replica push

Push preview data to Salesforce.

replica push                       # Push last preview
replica push --preview <id>        # Push specific preview
replica push --connection <id>     # Use specific connection

Options:

• -p, --preview <id> - Preview ID
• -c, --connection <id> - Salesforce connection ID

replica templates

List available templates.

replica templates                      # List all templates
replica templates --category industry  # Filter by category
replica templates --show saas-startup  # Show template details

Options:

• -c, --category <type> - Filter by category
• -s, --show <slug> - Show template details

replica config

Manage CLI configuration.

replica config                      # Show all settings
replica config set outputDir ./data # Set a value
replica config get apiUrl           # Get a value
replica config reset                # Reset to defaults
replica config path                 # Show config file path

Configuration

The CLI stores configuration in:

• macOS: ~/Library/Preferences/replica-cli-nodejs/config.json
• Linux: ~/.config/replica-cli-nodejs/config.json
• Windows: %APPDATA%/replica-cli-nodejs/Config/config.json

Available settings:

• apiKey - Your Replica API key (set via replica login)
• apiUrl - API URL (defaults to production)
• defaultConnectionId - Default Salesforce connection
• defaultTemplate - Default template slug
• outputFormat - Export format (json or csv)
• outputDir - Default export directory

Examples

Generate SaaS demo data

replica generate \
  --template saas-startup \
  --accounts 500 \
  --activities \
  --push \
  --connection demo-sandbox

Export for DataLoader

replica generate --template enterprise-b2b --accounts 1000
replica export --format csv --output ./dataloader-import

CI/CD Pipeline

# Generate test data before running Apex tests
replica generate --template testing-minimal --push --connection ci-sandbox

Support

• Documentation: docs.replica.datakarma.ai/cli
• Issues: github.com/datakarma/replica/issues