Add QUICK-START guide for VPS setup
This commit is contained in:
72
QUICK-START.md
Normal file
72
QUICK-START.md
Normal file
@@ -0,0 +1,72 @@
|
||||
# Quick Start: Setting Up Agents on a New VPS
|
||||
|
||||
## 30-Second Setup
|
||||
|
||||
Run this **once** on your new VPS to set up agents:
|
||||
|
||||
```bash
|
||||
bash <(curl -s http://100.120.125.113:3000/raw/pdm/homelab-agents/main/scripts/bootstrap-agents.sh)
|
||||
```
|
||||
|
||||
That's it! Your agents are ready to use.
|
||||
|
||||
## What Just Happened?
|
||||
|
||||
The bootstrap script:
|
||||
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
|
||||
|
||||
When you want to use an agent (like when closing a session):
|
||||
|
||||
1. Reference the agent by path:
|
||||
```
|
||||
~/.homelab-agents/agents/sysadmin-session-closer.md
|
||||
```
|
||||
|
||||
2. Or use Claude Code's agent features to load it
|
||||
|
||||
## Agent Auto-Updates
|
||||
|
||||
Every time you run the bootstrap:
|
||||
```bash
|
||||
bash ~/.homelab-agents/scripts/bootstrap-agents.sh
|
||||
```
|
||||
|
||||
It will pull the latest agent versions from Gitea. This means:
|
||||
- ✅ You edit an agent in Gitea
|
||||
- ✅ Next VPS to bootstrap gets the new version
|
||||
- ✅ All your VPS instances stay in sync
|
||||
|
||||
## Adding to ~/.bashrc (Optional)
|
||||
|
||||
For automatic setup on login:
|
||||
|
||||
```bash
|
||||
# Download the bootstrap script
|
||||
curl -s http://100.120.125.113:3000/raw/pdm/homelab-agents/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
|
||||
|
||||
Current agents in the repository:
|
||||
- **sysadmin-session-closer** - Closes sessions and creates session summaries
|
||||
- Add more agents anytime in `~/.homelab-agents/agents/`
|
||||
|
||||
## Next Steps
|
||||
|
||||
1. ✅ Bootstrap is complete
|
||||
2. Work on your VPS projects
|
||||
3. When done, use the session-closer agent
|
||||
4. All changes get committed to your project repo
|
||||
|
||||
For detailed information, see:
|
||||
- `README.md` - Overview and structure
|
||||
- `scripts/README.md` - Script documentation
|
||||
- `agents/README.md` - Available agents
|
||||
Reference in New Issue
Block a user