Files

root ba35a26c25 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

2025-11-23 21:39:09 +00:00

2.5 KiB

Raw Blame History

Quick Start: Setting Up Agents on a New VPS

Initial Setup (One-Time)

Run this once on your new VPS to bootstrap agents and helper tools:

bash <(curl -s http://100.120.125.113:3000/pdm/homelab-agents/raw/branch/main/scripts/bootstrap-agents.sh)

This:

✅ Clones homelab-agents to ~/.homelab-agents
✅ Installs helper scripts to ~/.homelab-scripts
✅ Sets up git configuration
✅ Makes agents ready to use

Creating a New Project

For each new project, use the init-project command:

# Create and initialize a new project (from your projects directory)
cd ~/projects
init-project my-new-app

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

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 bootstrap:

bash <(curl -s http://100.120.125.113:3000/pdm/homelab-agents/raw/branch/main/scripts/bootstrap-agents.sh)

It will:

✅ Pull latest agent versions
✅ Install latest helper scripts
✅ Keep your tools synchronized

Available Commands

After bootstrap:

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
Located at: ~/.homelab-agents/agents/

Project Structure

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

✅ Bootstrap (once): bash <(curl -s ...bootstrap-agents.sh)
✅ Init Project: init-project my-app
✅ Work: Create files, make changes
✅ Close Session: Use summary agent → auto-commits & pushes
✅ Resume: Clone from Gitea next time

For detailed information, see:

README.md - Overview and structure
scripts/README.md - Script documentation
agents/README.md - Available agents

2.5 KiB Raw Blame History