Dagger

In this guide, we will explain step-by-step how to integrate Dagger into Runme and how it works.

Getting Started

To proceed with this guide, it is crucial to carry out the following actions:

Install Runme

Install the Runme extension in your VS Code editor. Runme also provides other client interfaces where you can run your Markdown file. Once installed, you can make Runme your default Markdown viewer.

Install Docker(if not already installed)

Get Docker installed and running on your local machine. You can download Docker from the official website. After downloading Docker, you need to keep it running before executing any command.

Install Dagger

Install Dagger on your local machine. The Dagger installation guide provides more information on how to install Dagger on any platform of your choice. if you have brew installed already run the command below to install dagger

brew install dagger/tap/dagger

Navigating the Dagger CLI Using Runme Notebooks

Dagger CLI is the core tool used to interact with Dagger’s functions. You can chain commands and build entire DevOps pipelines by calling dagger functions from the CLI.

This section will explore navigating the Dagger CLI in your Runme Notebooks. We will explain how it works in detail.

Writing Dagger Module within Runme Notebook cell

Runme Notebook interface includes a terminal environment with additional features, that gives you the experience of working in your regular terminal and more. With the Runme Notebook interface, you can write and execute Dagger commands.

Let’s explore the code block below.

dagger call \
    -m github.com/purpleclay/daggerverse/golang@v0.3.0 \
    --src "https://github.com/stateful/runme#main" \
    build \
        --arch $(go env GOARCH) \
        --os $(go env GOOS) \
    file \
        --path runme

This code uses the Dagger CLI to build a Go project from the runme GitHub repository using your system's architecture and Operating System. After the build, it fetches a specific file from the runme project.

Output:

runme binary

This output shows the steps executed by Dagger, which successfully performed the tasks in the code block.

Runme Interactive CLI Support

Runme offers additional support for the Dagger CLI by providing options and support based on the context of your current task.

When you insert a Dagger command into a Runme cell, Runme automatically provides helpful CLI options based on the type of result returned (like a file, directory, or text). It shows buttons like "Export" or "Size," allowing you to run the next step with a quick click.

runme cli dagger

To retrieve the file's name, click on Name. A code block similar to the one below will be created and automatically run to display the file's name.

dagger call \
    -m github.com/purpleclay/daggerverse/golang@v0.3.0 \
    --src "https://github.com/stateful/runme#main" \
    build \
        --arch $(go env GOARCH) \
        --os $(go env GOOS) \
    file \
        --path runme name

To get the size of your file, click on size. A code block similar to the one below will be created and automatically run to display the size of your file.

dagger call --progress=$PROGRESS \
  -m golang \
  --src ../runme \
  build \
  file \
    --path runme size

To view the contents of your file, click on content. A code block similar to the one below will be created and automatically run to display the contents of your file.

# This code block will show the contents of your specified file
dagger call \
    -m github.com/purpleclay/daggerverse/golang@v0.3.0 \
    --src "https://github.com/stateful/runme#main" \
    file \
    --path runme contents

To export your file, click on export. First, you will be prompted to choose where you'd like to save the file, and the file path will be displayed. After selecting the location, a code block similar to the one below will be created and automatically run to export your file.

# This code block will export the specified file from your project
dagger call \
    -m github.com/purpleclay/daggerverse/golang@v0.3.0 \
    --src "https://github.com/stateful/runme#main" \
    build \
        --arch $(go env GOARCH) \
        --os $(go env GOOS) \
    file \
    --path runme export --path runme

Running Dagger Functions with a Single Click

With the Runme interactive interface, you can run your Dagger functions with a single click. When you set up a function call within a notebook cell, Runme improves the experience by offering follow-up actions tailored to the return type.

This interactive interface makes the execution of complex pipelines easy and eliminates the need to type follow-up commands manually.

Running Dagger Pipelines in Runme (using the CLI)

More than just running Dagger commands, developing pipelines, or troubleshooting them in VSCode, Runme also helps you run your Dagger pipelines inside your notebook through the Runme CLI.

If you have a Markdown file with your dagger pipeline commands written, you can run your pipeline from the terminal by running this command $ runme run --filename my-notebook.md --all --skip-prompts.