dcupl CLI

The dcupl CLI connects your local development environment to dcupl Console. Push and pull project files, manage versions, and integrate dcupl into your CI/CD pipelines.

What is the CLI?

The CLI is a command-line tool that syncs your local project files with dcupl Console. It enables:

  • Local development - Edit models, data, and configurations in your preferred editor
  • Version control - Use Git for your dcupl configurations alongside your application code
  • CI/CD integration - Automate deployments with push commands in your pipelines
  • Team collaboration - Pull the latest changes from Console to your local environment

When to Use the CLI

Scenario Use CLI? Alternative
Edit models in VS Code Yes Console Model Editor
Deploy via GitHub Actions Yes Manual publish in Console
Quick data exploration No Console Data Explorer
Initial project setup Either Console for visual setup
Bulk file management Yes Console File Manager

CLI vs Console

The CLI and Console work together - they access the same project files:

┌─────────────────────────────────────────────────────────────────┐
│                        dcupl Project                            │
│  ┌─────────────────────────────────────────────────────────┐    │
│  │                   Project Files                          │    │
│  │  • Models (*.model.json)                                 │    │
│  │  • Data (*.csv, *.json)                                  │    │
│  │  • Configuration (dcupl.lc.json)                         │    │
│  └─────────────────────────────────────────────────────────┘    │
│              ↑                              ↑                    │
│          push/pull                    edit/publish               │
│              │                              │                    │
│     ┌────────┴────────┐          ┌─────────┴────────┐           │
│     │   dcupl CLI     │          │  dcupl Console   │           │
│     │  (your machine) │          │   (web browser)  │           │
│     └─────────────────┘          └──────────────────┘           │
└─────────────────────────────────────────────────────────────────┘

Changes made in Console appear when you pull. Changes pushed via CLI appear in Console immediately.

Quick Example

Typical CLI workflow
# Login to your dcupl account
dcupl login

# Initialize a project in current directory
dcupl init

# Pull existing files from Console
dcupl pull

# Edit files locally...
# Then push changes back
dcupl push

Key Features

File Synchronization

Push and pull files between your machine and Console:

dcupl pull          # Download files from Console
dcupl push          # Upload local changes to Console
dcupl push --force  # Overwrite remote changes

Version Management

Work with draft and published versions:

dcupl pull                    # Pull draft version (default)
dcupl pull --version v1.0.0   # Pull specific version
dcupl push                    # Push to draft

CI/CD Integration

Use environment variables for automated pipelines:

export DCUPL_PROJECT_ID=your-project-id
export DCUPL_API_KEY=your-cli-api-key

dcupl push  # Uses environment variables

Next Steps