Get started
Edit on GitHub

Installing CML as a Package

CML comes pre-installed in our provided Docker Images. Alternatively, GitHub users can also use the setup-cml action.

However, in all other cases, CML can be installed directly as a Node.js package using the package manager npm (see below):

npm i -g @dvcorg/cml

You may also need to install additional dependencies to use DVC plots and Vega-Lite:

sudo apt-get install -y \
  libcairo2-dev libfontconfig-dev \
  libgif-dev libjpeg-dev libpango1.0-dev librsvg2-dev
npm install -g vega-cli vega-lite

Installing Node.js

Instructions for installing Node.js and its package manager npm can be found below.

Install Node.js from source:

curl -sL | bash
apt-get update
apt-get install -y nodejs

Node.js is likely already available in most GitHub Actions runners. However, to install a particular version, add the following step to your workflow:

- uses: actions/setup-node@v1
    node-version: '14'

🐛 Found an issue? Let us know! Or fix it:

Edit on GitHub

Have a question? Join our chat, we will help you:

Discord Chat