Workflows

Package instructions, parameters, and settings into reusable, shareable one-click workflows.

What is a workflow

A workflow (Recipe) is a reusable task configuration file (.yaml / .json) that packages instructions, parameters, extensions, and model settings — turning repetitive multi-step tasks into one-click runs that you can also share.

Getting & installing

Install from a link: shared workflows use a goose://recipe?config=… deep link. Clicking it shows an install confirmation in the app; accepting adds it to your library.
Storage location: workflows you create in the app are stored in the app data directory. A project can also expose workflows in its .agents/recipes/ folder (the legacy .goose/recipes/ is still read).

Running a workflow

Open "Workflows" in the sidebar and pick one to see its details.

If parameters are defined, a form appears (required / optional / defaults).

Run it — the agent carries out the instructions; workflows with activity bubbles show suggested actions at the top, ready to click.

Safety note: workflows contain executable instructions and extension configurations — read a workflow before running one you don't recognize. The app asks for confirmation the first time you run an unconfirmed workflow.

Authoring your own workflow

Quick field reference (full schema follows the upstream format; all fields work in the desktop app):

Field	Purpose
`title` / `description`	Name and description
`instructions` (or `prompt`)	Task template; supports `{{parameter}}` placeholders
`parameters`	Parameter definitions (key, type, required/optional, default)
`activities`	Suggested-action bubbles at the top of the run page (`message:` prefix shows a hint)
`extensions`	Extension configuration required by this workflow
`settings`	Pin the model / provider and other run settings

Minimal example:


version: "1.0.0"
title: "Code Review Assistant"
description: "Review code with a configurable focus"
parameters:
  - key: focus
    input_type: string
    requirement: optional
    default: "best practices"
    description: "Review focus"
instructions: >
  Review the code in the current project with a focus on {{ focus }}.
  Output a list of issues and suggested improvements.
activities:
  - "message: Pick a focus to start the review."
  - "Review the open file for security issues"
  - "Summarize quality risks in the latest commit"

Going further

Scheduled runs: hand a workflow to "Schedules" to run it automatically on a cron rule — see Schedules.
Sub-recipes: a workflow can delegate subtasks to other workflows for complex processes.
Parameter placeholders: {{parameters}} are substituted consistently in instructions and activity bubbles — one workflow fits many scenarios.

This page is adapted from upstream open-source documentation (Apache-2.0) with modifications; see /legal/provenance for sources and changes.