Dagger TypeScript SDK

A client package for running Dagger pipelines.

What is the Dagger TypeScript SDK?

The Dagger TypeScript SDK contains everything you need to develop CI/CD pipelines in TypeScript or Javascript, and run them on any OCI-compatible container runtime.

Install

1npm install @dagger.io/dagger --save-dev

Local development

You may want to work on the TypeScript SDK and test it directly on a local node project.

1. Create a new Node project

:warning: Skip this step if you already have a node project

1mkdir my-test-ts-project
2
3# Init project (you may use yarn or pnpm)
4npm init -y
5
6# Add typescript
7npm install typescript ts-node --save-dev
8
9# Init typescript project
10npx tsc --init

2. Update project settings

Dagger exports its SDK using type module so you will need to also update your package.json to the same type.

Add or update the field type in your package.json from your project root directory:

1npm pkg set type=module

You must also update your tsconfig.json to use NodeNext as module.

1"module": "NodeNext"

3. Symlink Dagger local module

Go to the Dagger TypeScript SDK directory and do the following :

1cd path/to/dagger/sdk/typescript # go into the package directory
2npm link # creates global link

Go back to the root directory of your local project to link the TypeScript SDK.

1cd path/to/my_app # go into your project directory.
2npm link @dagger.io/dagger # link install the package

:bulb: Any changes to path/to/dagger/sdk/typescript will be reflected in path/to/my_app/node_modules/@dagger.io/dagger.

4. Make your contribution

While making SDK code modification you should watch the input files:

1cd path/to/dagger/sdk/typescript # go into the package directory
2yarn watch # Recompile the code when input files are modified

You can now import the local Dagger TypeScript SDK as if you were using the official one.

1import { connect } from "@dagger.io/dagger"

Documentation

Please visit our documentation for a full list of commands and examples.