agentsync-vcs/setup.html at master · sumanthp/agentsync-vcs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Setup Guide | agentsync-vcs</title>
    <style>
        body {
            font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif;
            line-height: 1.6;
            color: #24292e;
            max-width: 900px;
            margin: 0 auto;
            padding: 40px 20px;
            background-color: #f6f8fa;
        }
        nav {
            margin-bottom: 40px;
        }
        nav a {
            color: #0366d6;
            text-decoration: none;
            font-weight: bold;
        }
        nav a:hover {
            text-decoration: underline;
        }
        .container {
            background: white;
            padding: 40px;
            border-radius: 8px;
            box-shadow: 0 4px 6px rgba(0,0,0,0.1);
            border: 1px solid #e1e4e8;
        }
        h1, h2, h3 {
            color: #24292e;
            border-bottom: 1px solid #eaecef;
            padding-bottom: 10px;
        }
        h1 { font-size: 2.5em; margin-bottom: 30px; }
        .step {
            margin-bottom: 40px;
        }
        .step-number {
            display: inline-block;
            background: #0366d6;
            color: white;
            width: 30px;
            height: 30px;
            text-align: center;
            line-height: 30px;
            border-radius: 50%;
            margin-right: 10px;
            font-weight: bold;
        }
        pre {
            background: #272822;
            color: #f8f8f2;
            padding: 15px;
            border-radius: 5px;
            overflow-x: auto;
            font-size: 14px;
            margin: 15px 0;
        }
        code {
            background: #f1f1f1;
            padding: 2px 5px;
            border-radius: 3px;
            font-family: "SFMono-Regular", Consolas, "Liberation Mono", Menlo, monospace;
        }
        .note {
            background-color: #fffbdd;
            border: 1px solid #d1d5da;
            padding: 15px;
            border-radius: 5px;
            margin: 20px 0;
        }
        footer {
            text-align: center;
            margin-top: 50px;
            color: #6a737d;
            font-size: 0.9em;
        }
    </style>
</head>
<body>

<nav>
    <a href="index.html">&larr; Back to Demo</a>
</nav>

<div class="container">
    <h1>Getting Started</h1>

    <div class="step">
        <h2><span class="step-number">1</span> Prerequisites</h2>
        <p>Ensure you have the following installed on your machine:</p>
        <ul>
            <li><strong>Python 3.8+</strong></li>
            <li><strong>pip</strong> (Python package manager)</li>
            <li><strong>Git</strong> (To clone the repository or sync rules)</li>
        </ul>
    </div>

    <div class="step">
        <h2><span class="step-number">2</span> Installation</h2>
        <p>Install the package directly from <a href="https://pypi.org/project/agentsync-vcs/0.3.0/" target="_blank">PyPI</a>:</p>
        <pre>pip install agentsync-vcs</pre>

        <p>Or install from source:</p>
        <pre>git clone https://github.com/sumanthp/agent-sync.git
cd agent-sync
pip install -e .</pre>
    </div>

    <div class="step">
        <h2><span class="step-number">3</span> Initialize Your Project</h2>
        <p>Navigate to your project root and run the initialization command:</p>
        <pre>$ agentsync-vcs init</pre>
        <p>This creates a <code>sample-rule.md</code> and a <code>.agent-sync/config.json</code> file.</p>
    </div>

    <div class="step">
        <h2><span class="step-number">4</span> Connect Remote Rules (Optional)</h2>
        <p>If your team has a shared repository for agent rules, add it as a remote:</p>
        <pre>$ agentsync-vcs remote add https://github.com/my-org/agent-rules.git
$ agentsync-vcs sync</pre>
        <p>The <code>sync</code> command clones the repository to a local cache on your machine.</p>
        <p><strong>Other Remote Commands:</strong></p>
        <pre>$ agentsync-vcs remote list     # View configured remotes
$ agentsync-vcs remote remove https://github.com/my-org/agent-rules.git   # Remove a remote</pre>
    </div>

    <div class="step">
        <h2><span class="step-number">5</span> Define a Rule</h2>
        <p>Create Universal Markdown rules with YAML frontmatter. You can define advanced routing via the <code>type</code> field (e.g., <code>skill</code> or <code>global</code>):</p>
        <pre>---
name: api-expert
description: Specialized FastAPI skill
type: skill
globs: ["src/api/**/*.py"]
---
- Use Pydantic for validation.
- Return HTTP 400 for bad input.</pre>
    </div>

    <div class="step">
        <h2><span class="step-number">6</span> Sync to Your Tools</h2>
        <p>Use the <code>pull</code> command followed by your target tool. This will compile both local and remote rules into the specific IDE formats:</p>
        <pre># For Cursor (.cursor/rules/*.mdc)
$ agentsync-vcs pull cursor

# For Claude Code (.claude/skills/)
$ agentsync-vcs pull claude

# For Windsurf (.windsurf/rules/*.md)
$ agentsync-vcs pull windsurf

# For Trae (.trae/rules/*.md)
$ agentsync-vcs pull trae

# For Hermes (.hermes/skills/*.md)
$ agentsync-vcs pull hermes

# For Kiro (.kiro/steering/*.md)
$ agentsync-vcs pull kiro

# For GitHub Copilot (.github/instructions/*.md)
$ agentsync-vcs pull copilot

# For Gemini (GEMINI.md)
$ agentsync-vcs pull gemini

# For Codex (AGENTS.md)
$ agentsync-vcs pull codex</pre>
    </div>

    <div class="note">
        <strong>Tip:</strong> You can add your own <code>.md</code> files with YAML frontmatter to the project root, and <code>agentsync-vcs</code> will automatically include them in the next <code>pull</code>.
    </div>
</div>

<footer>
    agentsync-vcs &copy; 2026 Sumanth Polisetty
</footer>

</body>
</html>