Update: QUICK-START guide with init-project workflow
- 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:
102
QUICK-START.md
102
QUICK-START.md
@@ -1,70 +1,98 @@
|
||||
# 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 <(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:
|
||||
1. ✅ Cloned the homelab-agents repository to `~/.homelab-agents`
|
||||
2. ✅ Set up git remotes for your VPS project
|
||||
3. ✅ Verified all agents are available
|
||||
For each new project, use the init-project command:
|
||||
|
||||
## 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
|
||||
```bash
|
||||
# Create and initialize a new project (from your projects directory)
|
||||
cd ~/projects
|
||||
init-project my-new-app
|
||||
```
|
||||
|
||||
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
|
||||
|
||||
Every time you run the bootstrap:
|
||||
Every time you run bootstrap:
|
||||
```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:
|
||||
- ✅ You edit an agent in Gitea
|
||||
- ✅ Next VPS to bootstrap gets the new version
|
||||
- ✅ All your VPS instances stay in sync
|
||||
It will:
|
||||
- ✅ Pull latest agent versions
|
||||
- ✅ Install latest helper scripts
|
||||
- ✅ Keep your tools synchronized
|
||||
|
||||
## Adding to ~/.bashrc (Optional)
|
||||
|
||||
For automatic setup on login:
|
||||
## Available Commands
|
||||
|
||||
After bootstrap:
|
||||
```bash
|
||||
# Download the bootstrap script
|
||||
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
|
||||
init-project <name> # Initialize a new project with git remote
|
||||
```
|
||||
|
||||
## Available Agents
|
||||
|
||||
Current agents in the repository:
|
||||
- **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
|
||||
2. Work on your VPS projects
|
||||
3. When done, use the session-closer agent
|
||||
4. All changes get committed to your project repo
|
||||
Your typical VPS layout:
|
||||
```
|
||||
~/projects/
|
||||
├── 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:
|
||||
- `README.md` - Overview and structure
|
||||
|
||||
Reference in New Issue
Block a user