Skip to content

Commit ae1ed75

Browse files
committed
Update repository references after migration from agentt - Update GitHub repository URL to ofthemachine/gydnc.git - Replace repo:agentt tag references with repo:gydnc - Fix installation and testing instructions for standalone repository
1 parent 7ffff87 commit ae1ed75

5 files changed

Lines changed: 319 additions & 167 deletions

File tree

.cursor/rules/gydnc.mdc

Lines changed: 188 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,188 @@
1+
---
2+
description:
3+
globs:
4+
alwaysApply: true
5+
---
6+
# gydnc-interaction-framework
7+
# Guidance Agent Interaction Framework
8+
9+
## Intent
10+
Ensure effective guidance retrieval and creation through the gydnc CLI tool, adapting to evolving user requests throughout a session.
11+
12+
## Rules
13+
14+
### 1. Guidance Retrieval Workflow
15+
ALWAYS follow this sequence to ensure you have comprehensive guidance:
16+
17+
1. **BEGIN WITH OVERVIEW:** Start EVERY session by getting a complete overview of available guidance:
18+
```bash
19+
# CRITICAL: Get overview of ALL available guidance entities
20+
gydnc list --json
21+
```
22+
This step is NON-OPTIONAL. You must begin by understanding what guidance is available.
23+
24+
2. **FETCH DETAILED GUIDANCE:** After identifying relevant guidance from the overview, retrieve full details:
25+
```bash
26+
# Get complete guidance content for multiple entities in one command
27+
gydnc get <entity1> <entity2> <entity3>
28+
```
29+
Do NOT use the --json flag with 'get' commands, as the default output provides the complete guidance text.
30+
31+
3. **PREFER BATCH RETRIEVAL:** Always fetch multiple relevant guidance entities in a single command rather than separate commands.
32+
33+
4. **RE-FETCH AS REQUESTS EVOLVE:** When the user's request changes direction or introduces new requirements, IMMEDIATELY fetch additional relevant guidance:
34+
```bash
35+
# Example: When user asks about a new topic (e.g., "write a blog post")
36+
gydnc list --json
37+
gydnc get <relevant-blog-writing-guidance>
38+
```
39+
It is CRITICAL to adapt and fetch new guidance as the conversation progresses.
40+
41+
### 2. Guidance Creation Workflow
42+
When creating new guidance entities:
43+
44+
1. **PREFERRED PATTERNS:** Use these proven methods for content creation:
45+
46+
**Here-document pattern (inline content):**
47+
```bash
48+
cat << 'EOF' | gydnc create <alias> --title "Title" --tags "tag1,tag2"
49+
# Your content here
50+
Multiple lines work perfectly
51+
Code blocks are preserved
52+
EOF
53+
```
54+
55+
**Temp file pattern (complex content):**
56+
```bash
57+
# Write content to temp file, then pipe it
58+
cat temp-content.md | gydnc create <alias> --title "Title" --tags "tag1,tag2"
59+
```
60+
61+
2. **AVOID PROBLEMATIC PATTERNS:**
62+
- ❌ NEVER use `--body` flag for multi-line content
63+
- ❌ NEVER skip the mandatory `gydnc list --json` first step
64+
- ❌ NEVER run `gydnc init` unless explicitly needed (assume configuration exists)
65+
66+
3. **COMPLETE METADATA:** Always include comprehensive metadata when creating:
67+
```bash
68+
gydnc create <alias> --title "Title" --description "Description" --tags "type:recipe,scope:core"
69+
```
70+
71+
### 2a. Alias Hierarchy and Organization
72+
73+
**Use hierarchical aliases to organize guidance logically:**
74+
75+
| Category | Pattern | Example | Purpose |
76+
|----------|---------|---------|---------|
77+
| Must | `must/<topic>` | `must/safety-first` | Mandatory guidance |
78+
| Should | `should/<topic>` | `should/code-style` | Recommended practices |
79+
| Recipes | `recipes/<domain>/<action>` | `recipes/blog/post-creation` | Step-by-step procedures |
80+
| Process | `process/<workflow>` | `process/migration/cursor-rules-to-gydnc` | Workflow guidance |
81+
82+
**Examples of hierarchical creation:**
83+
```bash
84+
# Mandatory safety guidance
85+
cat << 'EOF' | gydnc create must/data-validation --title "Data Validation Requirements" --tags "type:requirement,scope:security"
86+
# Data Validation Requirements
87+
All user input must be validated...
88+
EOF
89+
90+
# Development recipe
91+
cat << 'EOF' | gydnc create recipes/testing/unit-test-setup --title "Unit Test Setup Guide" --tags "type:recipe,domain:testing"
92+
# Unit Test Setup Guide
93+
Steps to configure unit testing...
94+
EOF
95+
96+
# Process guidance
97+
cat << 'EOF' | gydnc create process/release/version-tagging --title "Version Tagging Process" --tags "type:process,scope:release"
98+
# Version Tagging Process
99+
How to tag releases properly...
100+
EOF
101+
```
102+
103+
### 3. Adaptive Guidance Retrieval
104+
As the user's needs evolve during a conversation:
105+
106+
1. **CONTINUOUS MONITORING:** Constantly evaluate if new guidance is needed based on:
107+
* Topic changes in the conversation
108+
* New requirements introduced by the user
109+
* Requests for specific outputs (blog posts, code, documentation)
110+
111+
2. **PROACTIVE RETRIEVAL:** When the conversation shifts, proactively fetch new guidance:
112+
```bash
113+
# When conversation shifts to implementation details
114+
gydnc get must/safety-first should/code-style
115+
116+
# When user requests a specific output format
117+
gydnc get recipes/blog/post-creation
118+
```
119+
120+
3. **VERIFICATION:** After fetching new guidance, verify it addresses the user's evolving needs before proceeding.
121+
122+
### 4. Command Syntax Reference
123+
124+
**Core Commands:**
125+
| Command | Purpose |
126+
|---------|---------|
127+
| `list` | Show all available guidance entities |
128+
| `get` | Retrieve guidance content |
129+
| `create` | Create new guidance |
130+
| `update` | Update existing guidance |
131+
132+
**Essential Patterns:**
133+
1. **Overview Retrieval (MANDATORY):**
134+
```bash
135+
gydnc list --json
136+
```
137+
138+
2. **Detailed Guidance Retrieval:**
139+
```bash
140+
gydnc get <entity1> [<entity2> ...]
141+
```
142+
143+
3. **Guidance Creation with Here-document:**
144+
```bash
145+
cat << 'EOF' | gydnc create <alias> --title "Title" --tags "tag1,tag2"
146+
# Content here
147+
EOF
148+
```
149+
150+
4. **Guidance Creation with Temp File:**
151+
```bash
152+
cat content.md | gydnc create <alias> --title "Title" --tags "tag1,tag2"
153+
```
154+
155+
5. **Guidance Update:**
156+
```bash
157+
cat << 'EOF' | gydnc update <alias>
158+
# Updated content here
159+
EOF
160+
```
161+
162+
### 5. Troubleshooting Common Issues
163+
164+
**"No such file or directory" when piping:**
165+
- Problem: File path resolution issues
166+
- Solution: Use here-documents (`cat << 'EOF'`) or ensure temp files exist
167+
168+
**"Active backend not initialized":**
169+
- Problem: Missing configuration or wrong directory
170+
- Solution: Ensure proper GYDNC_CONFIG or source user profile: `source ~/.zshrc`
171+
172+
**Empty content after creation:**
173+
- Problem: Content didn't pipe correctly
174+
- Solution: Use the exact here-document pattern shown above
175+
176+
**Session configuration issues:**
177+
- Problem: Environment variables not loaded
178+
- Solution: Start fresh terminal or source profile
179+
180+
## Notes
181+
- **ALWAYS start with `gydnc list --json`** - This is mandatory for understanding available guidance
182+
- The full guidance content is critical for understanding context and requirements
183+
- Never rely solely on the overview - always retrieve full guidance with `gydnc get`
184+
- Batch retrieval is preferred - get multiple entities in one command
185+
- As user requests evolve (e.g., "write a blog about this"), retrieve appropriate additional guidance
186+
- The most common error is failing to adapt and fetch new guidance as the conversation progresses
187+
- Assume configuration exists - don't run `gydnc init` unless explicitly needed
188+
- When in doubt, check for more comprehensive guidance that might be available
Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
---
2+
title: Converting Cursor Rules to gydnc
3+
description: Guidelines for migrating content from .cursor/rules and .agent behaviors/recipes to the gydnc format
4+
tags:
5+
- process:migration
6+
- tech:documentation
7+
---
8+
# Converting Cursor Rules to gydnc Guidance
9+
10+
## Overview
11+
This document provides a step-by-step process for migrating content from the older `.cursor/rules` and `.agent/behaviors/recipes` formats to the new gydnc guidance system.
12+
13+
## Prerequisites
14+
- Access to source content (`.cursor/rules/*.mdc` files or `.agent/{behaviors,recipes}/*` files)
15+
- gydnc CLI tool installed and initialized
16+
- Understanding of both the source and target formats
17+
18+
## Migration Steps
19+
20+
### 1. Source Analysis
21+
- Identify the source file format (MDC rules, behavior, or recipe)
22+
- Examine frontmatter (YAML) for metadata like title, description, tags
23+
- Review content structure and any special formatting
24+
25+
### 2. Format Conversion
26+
- Convert YAML frontmatter to gydnc expected format
27+
- Ensure Markdown content is properly formatted
28+
- Organize content into clear sections with appropriate headers
29+
30+
### 3. Tag Structure Alignment
31+
- Convert existing tags to follow the `category:value` style
32+
- Use standard tag categories: tech, lang, process, quality, etc.
33+
- Remove repository-specific tags for general guidance documents
34+
35+
### 4. Path Structure Planning
36+
- Create a logical hierarchical alias for the guidance
37+
- Follow conventions:
38+
- `must/` for critical behaviors
39+
- `should/` for recommended behaviors
40+
- `recipes/{domain}/{name}` for procedures
41+
- `process/{domain}/{name}` for processes
42+
43+
### 5. Content Adaptation
44+
- Update any references to legacy paths (e.g., ".agent/") to appropriate gydnc paths
45+
- Adjust "Related Guidance" sections to reference gydnc entities
46+
- Ensure proper formatting of code blocks and examples
47+
48+
### 6. Creation Process
49+
- Create a temporary file with the converted content
50+
- Use stdin piping to create the guidance entity:
51+
```bash
52+
cat converted_content.md | gydnc create \
53+
--title "Title" \
54+
--description "Description" \
55+
--tags "tag1,tag2,tag3" \
56+
path/to/guidance
57+
```
58+
59+
### 7. Verification
60+
- Retrieve the created guidance to verify formatting: `gydnc get path/to/guidance`
61+
- Check listing to ensure it appears correctly: `gydnc list --json --filter-tags "relevant-tag"`
62+
- Validate cross-references and links to other guidance entities
63+
64+
## Examples
65+
66+
### Example: Converting a Behavior
67+
**Source (.agent/behaviors/must/safety-first.bhv):**
68+
```yaml
69+
---
70+
id: safety-first
71+
title: Safety First (Error Prevention)
72+
priority: 900
73+
description: Prioritize safety and error prevention in all operations.
74+
tier: must
75+
tags:
76+
- scope:core
77+
- quality:safety
78+
- quality:security
79+
---
80+
81+
# Safety First
82+
[Content...]
83+
```
84+
85+
**Target Command:**
86+
```bash
87+
cat safety_first.md | gydnc create \
88+
--title "Safety First (Error Prevention)" \
89+
--description "Prioritize safety and error prevention in all operations." \
90+
--tags "scope:core,quality:safety,quality:security" \
91+
must/safety-first
92+
```
93+
94+
### Example: Converting a Recipe
95+
**Source (.agent/recipes/git/git-commit-creation.rcp):**
96+
```yaml
97+
---
98+
id: git-commit-creation
99+
type: recipe
100+
tags:
101+
- tech:git
102+
- topic:commit_message
103+
title: "Git Commit Creation"
104+
description: "Guidelines for creating meaningful git commits."
105+
---
106+
107+
# Git Commit Creation
108+
[Content...]
109+
```
110+
111+
**Target Command:**
112+
```bash
113+
cat git_commit.md | gydnc create \
114+
--title "Git Commit Creation" \
115+
--description "Guidelines for creating meaningful git commits." \
116+
--tags "tech:git,process:version_control" \
117+
recipes/git/commit-creation
118+
```
119+
120+
## Best Practices
121+
- Preserve the original intent and requirements of the guidance
122+
- Ensure all critical sections are maintained
123+
- Update examples to reflect current paths and tooling
124+
- Modernize content where appropriate
125+
- Remove outdated references or information
126+
- Test the guidance to ensure it works as expected in the new format

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@
1515

1616
```bash
1717
# Clone the repository
18-
git clone git@github.com:frison/agentt.git
18+
git clone git@github.com:ofthemachine/gydnc.git
1919

2020
# Build gydnc
21-
cd agentt/gydnc && make build
21+
cd gydnc && make build
2222

2323
# Move the binary to your PATH
2424
mv gydnc /usr/local/bin/ # or somewhere else on your PATH
@@ -120,5 +120,5 @@ gydnc includes a comprehensive integration test framework that uses a declarativ
120120

121121
```bash
122122
# Run integration tests
123-
cd gydnc && make test-integration
123+
make test-integration
124124
```

cmd/init_tag_ontology.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ This document defines the standard tags used in this guidance store.
2121
- example: Sample code or configurations
2222
- deprecated: Features or approaches that should no longer be used
2323

24-
Tags are `category:value` or `category:sub:value` (e.g., `lang:go`, `os:linux`, `repo:agentt`).
24+
Tags are `category:value` or `category:sub:value` (e.g., `lang:go`, `os:linux`, `repo:gydnc`).
2525
Tags are case-insensitive and can be combined.
2626

2727
## Core Tags
@@ -38,7 +38,7 @@ Tags are case-insensitive and can be combined.
3838
- os:linux
3939
- os:windows
4040
- os:macos
41-
- repo:agentt
41+
- repo:gydnc
4242
- repo:infra
4343
- repo:frontend
4444
- repo:backend

0 commit comments

Comments
 (0)