Import Existing Workflows
io.typeflows:typeflows-githubProblem: You have existing GitHub workflows, Dependabot configuration, or other repository settings that you want to convert to Typeflows Configuration-as-Code, but manually rewriting them would be time-consuming.
Solution: Use AI agents with pre-installed Typeflows knowledge to analyse your existing configuration files and automatically generate equivalent Typeflows configuration. The agents understand both your existing formats and Typeflows patterns, making the conversion process faster.
Install Agent Instructions
Install Typeflows instructions for your preferred AI agent. These instructions teach the agent about Typeflows concepts, patterns, and APIs:
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!
# Claude Code (installed as a custom `command`)
./gradlew typeflowsInstallClaude
# Cursor (installed as Cursor rules)
./gradlew typeflowsInstallCursor
# GitHub Copilot (installed as instructions)
./gradlew typeflowsInstallCopilot
# Junie (installed as guidelines)
./gradlew typeflowsInstallGenie
Request Workflow Import
Start your AI agent and request conversion of existing configuration. The agent will automatically load the Typeflows instructions and understand how to work with Typeflows APIs.
The agent will analyse your existing files, identify appropriate Typeflows APIs, generate equivalent configuration code, and suggest improvements or optimisations.
Review and Refine
The automated conversion provides a solid foundation, but requires review and refinement. Ask your agent to consolidate similar workflows, extract reusable components, and leverage Typeflows’ type safety features instead of string literals.
Export and Validate
Export the new configuration and carefully compare with your originals to ensure correctness:
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!
cd typeflows
mvn typeflows:export
git diff
Critical: LLMs are massive time savers but not perfect. Always compare the exported files line-by-line with your originals to catch any missed details or incorrect translations. Test thoroughly in a development environment before deploying to production.
Benefits
- Speed: Automated conversion is faster than manual rewriting
- Context Awareness: Agents understand both source and target formats
- Type Safety: Converted configuration uses Typeflows’ typed APIs
- Maintainability: Result is proper Configuration-as-Code, not just translated YAML
- Learning: See Typeflows patterns applied to your actual use cases