Getting Started

Examples for:

Gradle + Kotlin Maven + Java

This tutorial will get you up and running with Typeflows in under 5 minutes. You’ll install Typeflows and start implementing Configuration-as-Code for your repository.

Prerequisites

An existing project Git repo with a project setup for your build system of choice.

Step 1: Install Typeflows

Add Typeflows to your build system, including the GitHub and LLM modules:

Better Experience in Landscape Mode

The code examples look much better when viewed horizontally. Please rotate your device for the best experience!

Or view on a larger screen to see the code!

plugins {
	id("com.typeflows") version "1.0.0"
}

dependencies {
	typeflowsApi("com.typeflows:typeflows-github:1.0.0")
	typeflowsApi("com.typeflows:typeflows-llm:1.0.0")
}


<!--
In Maven projects, docs.how_to.composing_llm_agent_instructions.Typeflows should exist in a subproject called "typeflows".
This isolates it from the main application code and allows for better modularity.
-->
<project xmlns="http://maven.apache.org/POM/4.0.0"
		 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
		 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 
		 http://maven.apache.org/xsd/maven-4.0.0.xsd">
	
	<modelVersion>4.0.0</modelVersion>
	
	<dependencies>
		<dependency>
			<groupId>io.typeflows</groupId>
			<artifactId>typeflows-github</artifactId>
			<version>1.0.0</version>
		</dependency>

		<dependency>
			<groupId>io.typeflows</groupId>
			<artifactId>typeflows-llm</artifactId>
			<version>1.0.0</version>
		</dependency>
	</dependencies>
	
	<build>
		<plugins>
			<plugin>
				<groupId>io.typeflows</groupId>
				<artifactId>typeflows-maven-plugin</artifactId>
				<version>1.0.0</version>
				<configuration>
					<typeflowsClass>Typeflows</typeflowsClass>
				</configuration>
				<executions>
					<execution>
					    <goals>
					        <goal>export</goal>
					    </goals>
					</execution>
				</executions>
			</plugin>
		</plugins>
	</build>
</project>

Step 2: Create Source Folder

Create a Typeflows configuration directory:

Better Experience in Landscape Mode

The code examples look much better when viewed horizontally. Please rotate your device for the best experience!

Or view on a larger screen to see the code!

mkdir -p src/typeflows/kotlin

mkdir -p typeflows/src/main/java/typeflows

Step 3: Add Your First Managed Files

Let’s start with an AGENTS.md file and a Dependabot configuration. Create your source files:

Better Experience in Landscape Mode

The code examples look much better when viewed horizontally. Please rotate your device for the best experience!

Or view on a larger screen to see the code!

import io.typeflows.agents.Agents
import io.typeflows.github.DotGitHub
import io.typeflows.github.TypeflowsGitHubRepo
import io.typeflows.github.dependabot.DepdendabotSchedule
import io.typeflows.github.dependabot.Dependabot
import io.typeflows.github.dependabot.PackageEcosystem
import io.typeflows.github.dependabot.PackageEcosystem.Gradle
import io.typeflows.github.dependabot.PackageEcosystem.Maven
import io.typeflows.github.dependabot.ScheduleInterval.Weekly
import io.typeflows.github.dependabot.Update
import io.typeflows.util.Builder
import java.time.DayOfWeek.FRIDAY
import java.time.LocalTime

class Typeflows : Builder<TypeflowsGitHubRepo> {
	override fun build() = TypeflowsGitHubRepo {
		dotGithub = DotGitHub {
			dependabot = Dependabot {
				version = 2
				updates += Update(Gradle) {
					directory = "/"
					schedule = DepdendabotSchedule(Weekly) {
					    day = FRIDAY
					    time = LocalTime.of(12, 0)
					}
				}
			}
		}
		files += Agents.of(
			"""
				# AI Agents
				Instructions for AI agents working with this repository
			"""
		)
	}
}


import io.typeflows.agents.Agents;
import io.typeflows.github.DotGitHub;
import io.typeflows.github.TypeflowsGitHubRepo;
import io.typeflows.github.dependabot.DepdendabotSchedule;
import io.typeflows.github.dependabot.Dependabot;
import io.typeflows.github.dependabot.Update;
import io.typeflows.util.Builder;

import java.time.LocalTime;

import static io.typeflows.github.dependabot.PackageEcosystem.Maven;
import static io.typeflows.github.dependabot.ScheduleInterval.Weekly;
import static java.time.DayOfWeek.FRIDAY;

public class Typeflows implements Builder<TypeflowsGitHubRepo> {

	@Override
	public TypeflowsGitHubRepo build() {
		return TypeflowsGitHubRepo.create(r -> {
			r.dotGithub = DotGitHub.create(gh -> {
				gh.dependabot = Dependabot.create(d -> {
					d.version = 2;
					d.updates.add(Update.create(Maven, u -> {
					    u.directory = "/";
					    u.schedule = DepdendabotSchedule.create(Weekly, s -> {
					        s.day = FRIDAY;
					        s.time = LocalTime.of(12, 0);
					    });
					}));
				});
			});
			r.files.add(Agents.of(
				"""
					    # AI Agents
					    Instructions for AI agents working with this repository
					"""
			));
		});
	}
}

Step 4: Run Typeflows Export

Running the export task will export all of the configuration files defined in your Typeflows class:

Better Experience in Landscape Mode

The code examples look much better when viewed horizontally. Please rotate your device for the best experience!

Or view on a larger screen to see the code!

./gradlew typeflowsExport

cd typeflows
mvn typeflows:export

Step 5: Verify Output

Typeflows will create the necessary directories and files in your .github/ folder. Check that your ‘AGENTS.md’ and .github/dependabot.yml files have been created:

Better Experience in Landscape Mode

The code examples look much better when viewed horizontally. Please rotate your device for the best experience!

Or view on a larger screen to see the code!

version: 2
updates:
  - package-ecosystem: maven
	directory: "/"
	schedule:
	  interval: weekly
	  day: friday
	  time: "12:00"

# AI Agents

Instructions for AI agents working with this repository

Conclusion

Your AGENTS.md and Dependabot configuration are now managed by Typeflows, giving you:

Type safety - No more YAML syntax errors
IDE support - Autocomplete and validation
Dynamic construction - Use loops, conditionals, and functions to build complex configurations
Composability - Content (Markdown, YAML etc) can be composed from independently controlled parts
Reusability - Share configurations across projects

Your Typeflows class is now the single source of truth for your GitHub configuration. Any changes you make here will be reflected in your repository folder when you run the export process.

But this is just the beginning, as Typeflows can manage your entire repository setup, including workflows, version files and more!

Ready for the next step?

Writing Reusable Configuration

Learn to build parameterised configuration builders that eliminate duplication