From bd4f3210dfb96a9b8d710f19783ec69dcc12e18e Mon Sep 17 00:00:00 2001 From: Ruben Hwasser Date: Mon, 16 Feb 2026 21:04:20 +0100 Subject: [PATCH] basic readme and fixed some markdown linting errors --- CLAUDE.md | 14 ++++++---- README.md | 81 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 90 insertions(+), 5 deletions(-) create mode 100644 README.md diff --git a/CLAUDE.md b/CLAUDE.md index 6a33291..4361814 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -13,7 +13,7 @@ A reusable library of DevOps agents and skills for Claude Code. Drop the `.claud Agents are autonomous workers that handle complex, multi-step tasks. They run in isolated contexts and can use multiple skills. | Agent | Purpose | -|-------|---------| +| ----- | ------- | | `test-runner` | Runs tests, analyzes failures, suggests fixes | | `pr-reviewer` | Reviews code changes, checks quality and security | | `ci-cd-helper` | Debugs CI/CD pipeline issues | @@ -32,6 +32,7 @@ Agents are autonomous workers that handle complex, multi-step tasks. They run in ### Using Agents Agents are invoked via the Task tool with the agent name: + - "Run the test-runner agent to check all tests" - "Use pr-reviewer to review my changes" - "Use code-simplifier to simplify my recent changes" @@ -51,7 +52,7 @@ Skills are inline capabilities that can be invoked directly or used by agents. ### Development Skills | Skill | Purpose | -|-------|---------| +| ----- | ------- | | `/run-tests` | Execute tests based on project type | | `/analyze-coverage` | Analyze test coverage reports | | `/lint-code` | Run linters based on project config | @@ -68,7 +69,7 @@ Skills are inline capabilities that can be invoked directly or used by agents. ### Git/Release Skills | Skill | Purpose | -|-------|---------| +| ----- | ------- | | `/commit` | Create well-formatted commits | | `/commit-push` | Commit and push to remote | | `/review-changes` | Review staged/unstaged git changes | @@ -95,7 +96,7 @@ When skills and agents need context, they use the **Explore** agent with a topic Place CLAUDE.md files anywhere in your project to provide instructions: -``` +```txt project/ CLAUDE.md # Root - always read src/ @@ -106,6 +107,7 @@ project/ ``` CLAUDE.md files can contain: + - Coding conventions and patterns - Testing requirements - Security guidelines @@ -137,6 +139,7 @@ CLAUDE.md files can contain: ## Language Support All components are language-agnostic. They detect project type from: + - `package.json` (Node.js/JavaScript/TypeScript) - `pyproject.toml`, `setup.py`, `requirements.txt` (Python) - `go.mod` (Go) @@ -148,7 +151,7 @@ All components are language-agnostic. They detect project type from: ## Directory Structure -``` +```txt .claude/ agents/ test-runner.md @@ -194,6 +197,7 @@ All components are language-agnostic. They detect project type from: **Plans and temporary files must NOT be saved in the project directory.** When creating plans, improvement documents, or any temporary working files: + - Save to the user's `.claude` folder: `~/.claude/plans/` or `~/.claude/temp/` - On Windows: `C:\Users\\.claude\plans\` - Never create a `.claude/plans/` folder in the project diff --git a/README.md b/README.md new file mode 100644 index 0000000..5b534bf --- /dev/null +++ b/README.md @@ -0,0 +1,81 @@ +# Agent Library + +A collection of reusable agents and skills for Claude Code and VSCode Copilot. Provides autonomous workers for complex tasks like testing, code review, CI/CD debugging, refactoring, and more. + +## Quick Start + +Symlink the folders to your project: + +```bash +ln -s ~/AgentLibrary/.claude/agents ~/yourproject/.claude/agents +ln -s ~/AgentLibrary/.claude/skills ~/yourproject/.claude/skills +ln -s ~/AgentLibrary/.claude/rules ~/yourproject/.claude/rules +``` + +Or for a single folder: + +```bash +ln -s ~/AgentLibrary/.claude ~/yourproject/.claude +``` + +Then in Claude Code or VSCode Copilot: + +- Agents appear in the `/agents` menu +- Skills appear in the `/skills` menu +- Rules auto-load into context + +## What's Included + +**14 Agents** for autonomous multi-step work: + +- `test-runner`, `pr-reviewer`, `code-architect`, `bug-fixer`, `feature-implementer` +- `release-manager`, `dependency-manager`, `project-setup` +- Plus specialized agents for CI/CD, code simplification, pattern evaluation, and more + +**20+ Skills** for targeted capabilities: + +- Development: test execution, linting, code analysis, test generation +- Git/Release: commit management, PR creation, release notes, advanced workflows +- Context: dependency management, environment validation, API documentation + +## Usage + +### Agents (Complex Multi-Step Tasks) + +```text +"Use code-architect to review the architecture" +"Use bug-fixer to diagnose and fix [bug description]" +"Use feature-implementer to implement [feature description]" +``` + +### Skills (Quick Capabilities) + +```text +/run-tests +/lint-code +/commit-push +/create-pr +``` + +## Context System + +Add `CLAUDE.md` files to your project to provide instructions: + +```text +yourproject/ + CLAUDE.md # Root instructions (always read) + src/ + CLAUDE.md # Feature-specific instructions +``` + +Instructions are discovered and applied automatically based on task context. + +## Documentation + +See [CLAUDE.md](./CLAUDE.md) for detailed agent/skill documentation, capabilities, and context system details. + +## Requirements + +- Claude Code or VSCode Copilot with Claude model +- Git repository in your project +- Symlinks must point to the correct paths