Update: QUICK-START to clarify repository creation step
- Emphasize: Create repo on Gitea FIRST, then init-project - Add Step 1: Create repository on Gitea web UI - Add Step 2: Run init-project to configure local repo - Update workflow summary to show correct order - Add SSH key setup section - Clarify that init-project connects to existing repo
This commit is contained in:
@@ -12,14 +12,22 @@ This:
|
||||
- ✅ Clones homelab-agents to `~/.homelab-agents`
|
||||
- ✅ Installs helper scripts to `~/.homelab-scripts`
|
||||
- ✅ Sets up git configuration
|
||||
- ✅ **Makes agents and commands available immediately** (no shell restart needed!)
|
||||
- ✅ **Makes agents and commands available immediately**
|
||||
|
||||
## Creating a New Project
|
||||
|
||||
For each new project, use the init-project command:
|
||||
### Step 1: Create Repository on Gitea (One-time per project)
|
||||
|
||||
Go to http://100.120.125.113:3000/repo/create and create a new repository:
|
||||
- **Repository name**: `my-new-app` (must match your project name)
|
||||
- **Visibility**: Public or Private (your choice)
|
||||
- **Initialize repository**: Optional (leave unchecked, init-project will set it up)
|
||||
|
||||
### Step 2: Initialize Project Locally
|
||||
|
||||
From your projects directory:
|
||||
|
||||
```bash
|
||||
# Create and initialize a new project (from your projects directory)
|
||||
cd ~/projects
|
||||
init-project my-new-app
|
||||
```
|
||||
@@ -27,7 +35,7 @@ init-project my-new-app
|
||||
This:
|
||||
- ✅ Creates `my-new-app` directory
|
||||
- ✅ Initializes git repository
|
||||
- ✅ **Automatically configures Gitea remote**
|
||||
- ✅ **Configures SSH remote to your Gitea repo**
|
||||
- ✅ Copies agents to `.claude/agents/`
|
||||
- ✅ Sets git user config
|
||||
- ✅ Ready to start work
|
||||
@@ -44,7 +52,7 @@ cd ~/projects/my-new-app
|
||||
# The agent will:
|
||||
# - Commit all changes with descriptive message
|
||||
# - Create session summary
|
||||
# - Automatically push to Gitea
|
||||
# - Automatically push to Gitea via SSH
|
||||
```
|
||||
|
||||
## Agent Auto-Updates
|
||||
@@ -63,7 +71,7 @@ It will:
|
||||
|
||||
After bootstrap:
|
||||
```bash
|
||||
init-project <name> # Initialize a new project with git remote
|
||||
init-project <name> # Initialize a new project (repo must exist on Gitea)
|
||||
```
|
||||
|
||||
## Available Agents
|
||||
@@ -78,13 +86,13 @@ Your typical VPS layout:
|
||||
```
|
||||
~/projects/
|
||||
├── project-1/
|
||||
│ ├── .git (remote: http://100.120.125.113:3000/pdm/project-1.git)
|
||||
│ ├── .git (remote: git@100.120.125.113:pdm/project-1.git)
|
||||
│ └── .claude/agents/ (agents for Claude Code)
|
||||
├── project-2/
|
||||
│ ├── .git (remote: http://100.120.125.113:3000/pdm/project-2.git)
|
||||
│ ├── .git (remote: git@100.120.125.113:pdm/project-2.git)
|
||||
│ └── .claude/agents/
|
||||
└── project-3/
|
||||
├── .git (remote: http://100.120.125.113:3000/pdm/project-3.git)
|
||||
├── .git (remote: git@100.120.125.113:pdm/project-3.git)
|
||||
└── .claude/agents/
|
||||
```
|
||||
|
||||
@@ -92,13 +100,26 @@ Each project is independent with its own Gitea repository and local agents.
|
||||
|
||||
## Workflow Summary
|
||||
|
||||
1. ✅ **Bootstrap** (once): `source <(curl -s ...bootstrap-agents.sh)`
|
||||
2. ✅ **Init Project**: `init-project my-app` (agents copied automatically)
|
||||
3. ✅ **Work**: Create files, make changes
|
||||
4. ✅ **Close Session**: Use summary agent → auto-commits & pushes
|
||||
5. ✅ **Resume**: Clone from Gitea next time
|
||||
1. ✅ **Bootstrap** (once per VPS): `source <(curl -s ...bootstrap-agents.sh)`
|
||||
2. ✅ **Create Repo on Gitea** (once per project): http://100.120.125.113:3000/repo/create
|
||||
3. ✅ **Init Project** (once per project): `init-project my-app`
|
||||
4. ✅ **Work**: Create files, make changes
|
||||
5. ✅ **Close Session**: Use summary agent → auto-commits & pushes
|
||||
6. ✅ **Resume**: Clone from Gitea next time
|
||||
|
||||
## SSH Key Setup
|
||||
|
||||
For git push to work, your VPS needs an SSH key configured on Gitea:
|
||||
|
||||
1. Generate key: `ssh-keygen -t ed25519 -f ~/.ssh/id_ed25519 -N ""`
|
||||
2. Get public key: `cat ~/.ssh/id_ed25519.pub`
|
||||
3. Add to Gitea: http://100.120.125.113:3000/user/settings/keys
|
||||
4. Test: `ssh -T git@100.120.125.113`
|
||||
|
||||
See [SSH-SETUP.md](SSH-SETUP.md) for detailed instructions.
|
||||
|
||||
For detailed information, see:
|
||||
- `README.md` - Overview and structure
|
||||
- `scripts/README.md` - Script documentation
|
||||
- `SSH-SETUP.md` - SSH key configuration
|
||||
- `agents/README.md` - Available agents
|
||||
Reference in New Issue
Block a user