From 7f2ccb491fadf343d54f68514a413db0fb84c5a8 Mon Sep 17 00:00:00 2001 From: Derek Cooper Date: Tue, 27 Oct 2026 23:58:51 -0700 Subject: [PATCH] updated to include new files --- README.md | 30 +++++++++++++++++++++--------- 1 file changed, 21 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 90629d7..6642350 100644 --- a/README.md +++ b/README.md @@ -10,22 +10,30 @@ A personal repository of markdown files that define how AI systems should work w AI/ ├── CLAUDE.md # Main entry point — loaded automatically by Claude Code ├── playbooks/ +│ ├── docker-security-audit.md # Vulnerability/secrets audit of Docker images (Trivy, Grype) +│ ├── M365-Graph-Form-Email-Setup.md # Website form → email via FastAPI + Microsoft Graph (M365 tenant) │ ├── service-golive.md # Pre-go-live review checklist for services exposed via NPM │ └── service-update.md # Recurring maintenance review for already-live services -└── preferences/ - ├── articles.md # Blog post writing guide for chns.tech (Hugo/Markdown) - ├── communication.md # How I like responses structured and how to interact - ├── hooks-setup.md # Required Claude Code hooks and setup instructions - ├── powershell-wpf.md # Standards for PowerShell and WPF applications - ├── python-web.md # Standards for FastAPI, SQLAlchemy, Docker Compose - └── project-structure.md # Standard folder layouts per project type +├── preferences/ +│ ├── articles.md # Blog post writing guide for chns.tech (Hugo/Markdown) +│ ├── communication.md # How I like responses structured and how to interact +│ ├── hooks-setup.md # Required Claude Code hooks and setup instructions +│ ├── powershell-wpf.md # Standards for PowerShell and WPF applications +│ ├── python-web.md # Standards for FastAPI, SQLAlchemy, Docker Compose +│ └── project-structure.md # Standard folder layouts per project type +└── slash-commands/ + └── update-deps.md # /update-deps — audit, update, test, and commit all dependencies ``` +> `containers.local.txt` and `reports/` (used by the Docker security audit playbook) are git-ignored. + **`CLAUDE.md`** is the top-level summary. It references the `preferences/` files for detail. This is the file you point AI tools to — or it gets picked up automatically. **`preferences/`** contains the detail files. Each covers a specific domain. You generally don't point tools directly at these; `CLAUDE.md` references them for context. -**`playbooks/`** contains step-by-step AI-guided checklists for specific tasks. Each playbook is invoked on demand — tell the AI to use it and it walks through the steps interactively. +**`playbooks/`** contains step-by-step AI-guided checklists and setup guides for specific tasks. Each playbook is invoked on demand — tell the AI to use it (pointing at its raw URL, e.g. `https://git.chns.tech/CHNS/AI/raw/branch/main/playbooks/service-golive.md`) and it walks through the steps interactively. + +**`slash-commands/`** contains Claude Code custom slash commands. Each file becomes `/` once linked into `~/.claude/commands/` (see setup below). --- @@ -37,7 +45,7 @@ Claude Code automatically reads `~/.claude/CLAUDE.md` globally, and any `CLAUDE. **Recommended setup (symlinks + auto-pull across machines):** -Clone this repo locally and symlink `CLAUDE.md` and `preferences/` into `~/.claude/`. From that point on, `git pull` is the only sync step — and the auto-pull hook in `preferences/hooks-setup.md` handles that automatically on every session. +Clone this repo locally and symlink `CLAUDE.md`, `preferences/`, and `slash-commands/` (as `commands/`) into `~/.claude/`. From that point on, `git pull` is the only sync step — and the auto-pull hook in `preferences/hooks-setup.md` handles that automatically on every session. **Linux (one-time setup per machine):** @@ -45,6 +53,7 @@ Clone this repo locally and symlink `CLAUDE.md` and `preferences/` into `~/.clau git clone https://git.chns.tech/CHNS/AI ~/AI ln -sf ~/AI/CLAUDE.md ~/.claude/CLAUDE.md ln -sf ~/AI/preferences ~/.claude/preferences +ln -sfn ~/AI/slash-commands ~/.claude/commands ``` **Windows (one-time setup — requires Developer Mode or run PowerShell as Administrator):** @@ -55,8 +64,11 @@ Remove-Item "$env:USERPROFILE\.claude\CLAUDE.md" -Force -ErrorAction SilentlyCon Remove-Item "$env:USERPROFILE\.claude\preferences" -Recurse -Force -ErrorAction SilentlyContinue New-Item -ItemType SymbolicLink -Path "$env:USERPROFILE\.claude\CLAUDE.md" -Target "C:\AI\CLAUDE.md" New-Item -ItemType SymbolicLink -Path "$env:USERPROFILE\.claude\preferences" -Target "C:\AI\preferences" +New-Item -ItemType SymbolicLink -Path "$env:USERPROFILE\.claude\commands" -Target "C:\AI\slash-commands" ``` +> If `~/.claude/commands` already exists with your own commands, move them into `slash-commands/` first (or symlink individual files instead of the folder). + After symlinking, configure hooks from `preferences/hooks-setup.md` — the auto-pull hook will keep preferences current automatically. ---