Skip to content


Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

Latest commit


Git stats


Failed to load latest commit information.
Latest commit message
Commit time


CircleCI npm version

CWL-ts is a data model library for the Common Workflow Language made for use in TypeScript and JavaScript (primarily client-side) applications.

It supports JSON schemas and mappings for draft-3, draft-4, and v1.0. Draft-2 support is SevenBridges flavored.


npm install cwlts


The npm package can be built locally by running the following command. It will generate .d.ts and compiled .js files into the /lib directory.



lib/mappings contains TypeScript interfaces that can be used for type hinting when working with CWL documents in TS/JS.


lib/schemas contains JSON Schema definitions for CommandLineTool, Workflow and ExpressionTool for each draft/version. They can be used with a JSON Schema validator to ensure schema validity of a CWL document.

Models [WIP]

lib/models contains TypeScript classes representing CWL entities. Models are still in early development, so many intended features are not implemented yet or don't function properly. The purpose of these models is to provide a set of methods that will facilitate working with CWL in a client-side application--one that graphically displays CWL documents or creates them. They should abstract differences between drafts and versions, provide a consistent API, and always generate correct and valid CWL documents.

CommandLineToolModel should:

  • generate command line when supplied test data
  • evaluate and validate expressions
  • enable operations on complex child objects (inputs, outputs, arguments, etc)

WorkflowModel should:

  • generate DAG of workflow
  • enable adding and connecting steps
  • enable operations on complex child objects (inputs, outputs, steps, etc)