pdm/homelab-agents
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update: QUICK-START guide with init-project workflow

Browse Source 
- Document complete VPS setup workflow
- Show init-project usage for new projects
- Explain project structure (separate repos)
- Simplify instructions for clarity
- Include agent auto-update info
This commit is contained in:
root
2025-11-23 21:39:09 +00:00
parent bd3cda3f1d
commit ba35a26c25
1 changed files with 64 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

102
QUICK-START.md
View File

@@ -1,70 +1,98 @@
# Quick Start: Setting Up Agents on a New VPS # Quick Start: Setting Up Agents on a New VPS
## 30-Second Setup ## Initial Setup (One-Time)
Run this **once** on your new VPS to set up agents: Run this **once** on your new VPS to bootstrap agents and helper tools:
```bash ```bash
bash <(curl -s http://100.120.125.113:3000/pdm/homelab-agents/raw/branch/main/scripts/bootstrap-agents.sh) bash <(curl -s http://100.120.125.113:3000/pdm/homelab-agents/raw/branch/main/scripts/bootstrap-agents.sh)
``` ```
That's it! Your agents are ready to use. This:
- ✅ Clones homelab-agents to `~/.homelab-agents`
- ✅ Installs helper scripts to `~/.homelab-scripts`
- ✅ Sets up git configuration
- ✅ Makes agents ready to use
## What Just Happened? ## Creating a New Project
The bootstrap script: For each new project, use the init-project command:
1. ✅ Cloned the homelab-agents repository to `~/.homelab-agents`
2. ✅ Set up git remotes for your VPS project
3. ✅ Verified all agents are available
## Using Agents in Claude Code ```bash
# Create and initialize a new project (from your projects directory)
When you want to use an agent (like when closing a session): cd ~/projects
init-project my-new-app
1. Reference the agent by path:
```
~/.homelab-agents/agents/sysadmin-session-closer.md
``` ```
2. Or use Claude Code's agent features to load it This:
- ✅ Creates `my-new-app` directory
- ✅ Initializes git repository
- ✅ **Automatically configures Gitea remote**
- ✅ Sets git user config
- ✅ Ready to start work
## Working on a Project
```bash
cd ~/projects/my-new-app
# Do your work...
# Add files, make changes, etc.
# When done, close the session with the summary agent
# The agent will:
# - Commit all changes with descriptive message
# - Create session summary
# - Automatically push to Gitea
```
## Agent Auto-Updates ## Agent Auto-Updates
Every time you run the bootstrap: Every time you run bootstrap:
```bash ```bash
bash ~/.homelab-agents/scripts/bootstrap-agents.sh bash <(curl -s http://100.120.125.113:3000/pdm/homelab-agents/raw/branch/main/scripts/bootstrap-agents.sh)
``` ```
It will pull the latest agent versions from Gitea. This means: It will:
- ✅ You edit an agent in Gitea - ✅ Pull latest agent versions
- ✅ Next VPS to bootstrap gets the new version - ✅ Install latest helper scripts
- ✅ All your VPS instances stay in sync - ✅ Keep your tools synchronized
## Adding to ~/.bashrc (Optional) ## Available Commands
For automatic setup on login:
After bootstrap:
```bash ```bash
# Download the bootstrap script init-project <name> # Initialize a new project with git remote
curl -s http://100.120.125.113:3000/pdm/homelab-agents/raw/branch/main/scripts/bootstrap-agents.sh > ~/.homelab-setup.sh
chmod +x ~/.homelab-setup.sh
# Add to ~/.bashrc:
# source ~/.homelab-setup.sh 2>/dev/null || true
``` ```
## Available Agents ## Available Agents
Current agents in the repository: Current agents in the repository:
- **sysadmin-session-closer** - Closes sessions and creates session summaries - **sysadmin-session-closer** - Closes sessions and creates session summaries
- Add more agents anytime in `~/.homelab-agents/agents/` - Located at: `~/.homelab-agents/agents/`
## Next Steps ## Project Structure
1. ✅ Bootstrap is complete Your typical VPS layout:
2. Work on your VPS projects ```
3. When done, use the session-closer agent ~/projects/
4. All changes get committed to your project repo ├── project-1/
│ └── .git (remote: http://100.120.125.113:3000/pdm/project-1.git)
├── project-2/
│ └── .git (remote: http://100.120.125.113:3000/pdm/project-2.git)
└── project-3/
└── .git (remote: http://100.120.125.113:3000/pdm/project-3.git)
```
Each project is independent with its own Gitea repository.
## Workflow Summary
1. ✅ **Bootstrap** (once): `bash <(curl -s ...bootstrap-agents.sh)`
2. ✅ **Init Project**: `init-project my-app`
3. ✅ **Work**: Create files, make changes
4. ✅ **Close Session**: Use summary agent → auto-commits & pushes
5. ✅ **Resume**: Clone from Gitea next time
For detailed information, see: For detailed information, see:
- `README.md` - Overview and structure - `README.md` - Overview and structure