From 150f67c9b90c4c1432be9fea55fdf49177475bab Mon Sep 17 00:00:00 2001 From: root Date: Sun, 23 Nov 2025 22:08:22 +0000 Subject: [PATCH] Update: README with new bootstrap workflow - Lead with 'source' bootstrap command - Point to QUICK-START for details - Show new project init-project workflow - Clarify agents available at .claude/agents/ - Update usage section - Keep structure and documentation references --- README.md | 72 +++++++++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 59 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 6c656e6..4913a7d 100644 --- a/README.md +++ b/README.md @@ -2,23 +2,69 @@ Central storage for AI agent prompts shared across all VPS instances. +## Quick Start + +For new VPS instances, run this once: + +```bash +source <(curl -s http://100.120.125.113:3000/pdm/homelab-agents/raw/branch/main/scripts/bootstrap-agents.sh) +``` + +This sets up everything you need. See [QUICK-START.md](QUICK-START.md) for detailed instructions. + ## Structure - `agents/` - Agent prompt definitions +- `scripts/` - Helper scripts (bootstrap-agents.sh, init-project, etc.) - `templates/` - Template files for agents and session summaries -- `scripts/` - Installation and utility scripts - -## Usage - -Clone this repository on any VPS: -```bash -git clone http://100.120.125.113:3000/pdm/homelab-agents.git ~/.homelab-agents -``` - -Update agents: -```bash -cd ~/.homelab-agents && git pull -``` ## Available Agents - **sysadmin-session-closer** - Automatically closes and documents dev sessions + - Use at end of sessions to commit and push work + - Generates comprehensive session summaries + - Handles git workflows automatically + +## Usage + +### First Time on a VPS + +```bash +source <(curl -s http://100.120.125.113:3000/pdm/homelab-agents/raw/branch/main/scripts/bootstrap-agents.sh) +``` + +### Create a New Project + +```bash +init-project my-project +cd my-project +# Start working... +``` + +Each project automatically gets: +- Git repo with Gitea remote configured +- Agents available at `.claude/agents/` +- Git user info set up + +### Close a Session + +Use the summary agent from your project: +``` +.claude/agents/sysadmin-session-closer.md +``` + +The agent will: +- Create comprehensive session summary +- Commit all changes +- Push to Gitea automatically + +## Documentation + +- [QUICK-START.md](QUICK-START.md) - Fast setup guide for new VPS instances +- [scripts/README.md](scripts/README.md) - Documentation for helper scripts +- [agents/README.md](agents/README.md) - Information about available agents + +## Repository Information + +- **Location**: http://100.120.125.113:3000/pdm/homelab-agents +- **Access**: Internal network only +- **Purpose**: Centralized AI agent prompts for all homelab VPS instances \ No newline at end of file