agent-sync Configuration Reference

Overview

agent-sync is a tool for managing and converting context and command definitions for AI agents such as Claude, Roo, Cline, and Copilot. This reference documents all configuration options available in the agent-sync.yml file.

Documentation Structure

The configuration documentation has been organized into several focused documents:

Configuration Reference - Detailed configuration parameters and settings
Input and Output Processing - Input handling, output paths, and file processing
Task Types - Memory, command, and mode task types with agent-specific details
Template System - Template functions and path resolution
Command Line Interface - Command line options and usage
Troubleshooting - Error handling and debugging
Examples and Best Practices - Configuration examples and recommendations

Configuration File Location

By default, agent-sync looks for the following files in the current directory:

agent-sync.yml
agent-sync.yaml

A specific file path can also be directly specified using the --config command line option.

Basic Structure

The configuration file can be organized in two formats: standard or simplified.

Standard Format

configVersion: "1.0"
projects:
  project-name:
    # Project-specific configuration
user:
  # Global user-level configuration

Simplified Format (Single Project)

configVersion: "1.0"
outputDirs:
  - ~/projects/my-app
tasks:
  # Project tasks defined directly at root level

Previous	Next
	Configuration Reference

Back to index