Skip to content

AGENT_INSTRUCTIONS.md

Latest commit

 

History

History
179 lines (120 loc) · 4.68 KB

AGENT_INSTRUCTIONS.md

File metadata and controls

179 lines (120 loc) · 4.68 KB
Raw

Agent Instructions

You are an agent reading this repository so you can install Agent Teaching Mode for the user.

Your job is to install the skill files, preserve attribution, and tell the user exactly what changed.

Operating Rules

  • Treat the user as the product owner and technical operator.
  • Do not invent credentials, policies, external state, or production configuration.
  • Do not overwrite an existing customized skill without first preserving a backup.
  • Prefer copying complete skill folders over manually merging partial Markdown.
  • Preserve third-party attribution for the architecture diagram generator.
  • After installation, report the exact destination paths and any skipped steps.

Repo Contents

skills/agent-teaching-mode/
  SKILL.md
  references/teaching-rules.md
  references/explanation-checklist.md

skills/architecture-diagram-generator/
  SKILL.md
  assets/template.html

prompts/agent-teaching-mode.prompt.md
prompts/architecture-first-build.prompt.md
THIRD_PARTY_NOTICES.md

What To Install

Install both skills when the target agent supports skill folders:

  1. skills/agent-teaching-mode
  2. skills/architecture-diagram-generator

Why both:

  • agent-teaching-mode is the teaching overlay.
  • architecture-diagram-generator is the diagram lane that teaching mode uses before implementation.

Detect The Target Skill Directory

Use the user's agent environment when it is obvious.

Common destinations:

~/.codex/skills
~/.claude/skills
./.codex/skills
./.claude/skills

Use global install directories when the user asks for the skill to be available across projects.

Use project-local directories when the user only wants the skill available in the current repo.

Install Steps

Run these steps from the root of this repository.

  1. Confirm the source folders exist:
test -f skills/agent-teaching-mode/SKILL.md
test -f skills/architecture-diagram-generator/SKILL.md
  1. Create the destination skill directory:
mkdir -p ~/.codex/skills
  1. If an existing destination skill folder exists, back it up first:
timestamp="$(date +%Y%m%d-%H%M%S)"

if [ -d ~/.codex/skills/agent-teaching-mode ]; then
  mv ~/.codex/skills/agent-teaching-mode ~/.codex/skills/agent-teaching-mode.backup-"$timestamp"
fi

if [ -d ~/.codex/skills/architecture-diagram-generator ]; then
  mv ~/.codex/skills/architecture-diagram-generator ~/.codex/skills/architecture-diagram-generator.backup-"$timestamp"
fi
  1. Copy the skill folders:
cp -R skills/agent-teaching-mode ~/.codex/skills/
cp -R skills/architecture-diagram-generator ~/.codex/skills/
  1. Verify the installed files:
test -f ~/.codex/skills/agent-teaching-mode/SKILL.md
test -f ~/.codex/skills/agent-teaching-mode/references/teaching-rules.md
test -f ~/.codex/skills/agent-teaching-mode/references/explanation-checklist.md
test -f ~/.codex/skills/architecture-diagram-generator/SKILL.md
test -f ~/.codex/skills/architecture-diagram-generator/assets/template.html
  1. Report the install result to the user.

Include:

  • destination path
  • whether backups were created
  • whether both skills were installed
  • whether the user needs to restart or reload their CLI

Claude Code Install Variant

For Claude Code-style installs, use ~/.claude/skills:

mkdir -p ~/.claude/skills
cp -R skills/agent-teaching-mode ~/.claude/skills/
cp -R skills/architecture-diagram-generator ~/.claude/skills/

Use the same backup and verification approach described above.

Generic LLM CLI Prompt Variant

If the target CLI does not support skills, do not pretend skill loading exists.

Instead, tell the user to paste:

prompts/agent-teaching-mode.prompt.md

Use:

prompts/architecture-first-build.prompt.md

when the user wants only the architecture-first workflow without the full teaching overlay.

Upstream Architecture Diagram Option

The architecture diagram generator in this repo is adapted from Cocoon AI's MIT-licensed project:

https://github.com/Cocoon-AI/architecture-diagram-generator

If the user prefers the upstream version instead of the adapted local copy, download and install the upstream package from that repository.

Do not remove attribution. Preserve the MIT license notice if copying, modifying, or redistributing the architecture diagram generator.

Expected Final Response

After installation, answer in this shape:

Installed Agent Teaching Mode.

Installed:
- <destination>/agent-teaching-mode
- <destination>/architecture-diagram-generator

Backups:
- <list backups, or "none">

Notes:
- Architecture Diagram Generator is adapted from Cocoon AI's MIT-licensed project.
- Restart or reload your agent CLI so it discovers the new skills.