From 7f6e0893dd0c3b952430be27b3f0227b9ea91bef Mon Sep 17 00:00:00 2001 From: lmiranda Date: Wed, 21 Jan 2026 11:30:04 -0500 Subject: [PATCH] fix: update README.md with new setup commands and correct GITEA_ORG placement - Add /project-init and /project-sync commands to projman - Add setup commands (/initial-setup, /project-init, /project-sync) to pr-review - Add /initial-setup to cmdb-assistant - Replace manual MCP setup instructions with /initial-setup wizard - Move GITEA_ORG from system-level to project-level in examples - Add COMMANDS-CHEATSHEET.md and UPDATING.md to documentation table - Fix GITEA_ORG validation in projman initial-setup (was checking system config) Co-Authored-By: Claude Opus 4.5 --- README.md | 58 +++++++++++++---------- plugins/projman/commands/initial-setup.md | 4 +- 2 files changed, 36 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 93b8ca3..518dece 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ AI-guided sprint planning with full Gitea integration. Transforms a proven 15-sp - Branch-aware security (development/staging/production) - Pre-sprint-close code quality review and test verification -**Commands:** `/sprint-plan`, `/sprint-start`, `/sprint-status`, `/sprint-close`, `/labels-sync`, `/initial-setup`, `/review`, `/test-check`, `/test-gen` +**Commands:** `/sprint-plan`, `/sprint-start`, `/sprint-status`, `/sprint-close`, `/labels-sync`, `/initial-setup`, `/project-init`, `/project-sync`, `/review`, `/test-check`, `/test-gen` #### [git-flow](./plugins/git-flow/README.md) *NEW in v3.0.0* **Git Workflow Automation** @@ -44,7 +44,7 @@ Comprehensive pull request review using specialized agents. - Actionable feedback with suggested fixes - Gitea integration for automated review submission -**Commands:** `/pr-review`, `/pr-summary`, `/pr-findings` +**Commands:** `/pr-review`, `/pr-summary`, `/pr-findings`, `/initial-setup`, `/project-init`, `/project-sync` #### [claude-config-maintainer](./plugins/claude-config-maintainer/README.md) **CLAUDE.md Optimization and Maintenance** @@ -94,7 +94,7 @@ Security vulnerability detection and code refactoring tools. Full CRUD operations for network infrastructure management directly from Claude Code. -**Commands:** `/cmdb-search`, `/cmdb-device`, `/cmdb-ip`, `/cmdb-site` +**Commands:** `/initial-setup`, `/cmdb-search`, `/cmdb-device`, `/cmdb-ip`, `/cmdb-site` ## MCP Servers @@ -157,44 +157,50 @@ Add to `.claude/settings.json` in your target project: } ``` -### Configure MCP Server Dependencies +### Run Interactive Setup -Install dependencies for shared MCP servers: +After installing plugins, run the setup wizard: -```bash -# Gitea MCP (for projman, pr-review) -cd mcp-servers/gitea -python3 -m venv .venv -source .venv/bin/activate -pip install -r requirements.txt -deactivate - -# NetBox MCP (for cmdb-assistant) -cd ../netbox -python3 -m venv .venv -source .venv/bin/activate -pip install -r requirements.txt -deactivate +``` +/initial-setup ``` -### Configure Credentials +The wizard handles everything: +- Sets up MCP server (Python venv + dependencies) +- Creates system config (`~/.config/claude/gitea.env`) +- Guides you through adding your API token +- Detects and validates your repository via API +- Creates project config (`.env`) -See [docs/CONFIGURATION.md](./docs/CONFIGURATION.md) for complete setup instructions. +**For new projects** (when system is already configured): +``` +/project-init +``` + +**After moving a repository:** +``` +/project-sync +``` + +See [docs/CONFIGURATION.md](./docs/CONFIGURATION.md) for detailed instructions. + +### Manual Setup (Alternative) + +If you prefer manual setup: -**Quick start:** ```bash mkdir -p ~/.config/claude -# Gitea credentials +# System-level: Gitea credentials cat > ~/.config/claude/gitea.env << 'EOF' GITEA_URL=https://gitea.example.com GITEA_TOKEN=your_token -GITEA_ORG=your_org EOF chmod 600 ~/.config/claude/gitea.env -# Project-level settings +# Project-level: Repository specification cat > .env << 'EOF' +GITEA_ORG=your-organization GITEA_REPO=your-repository-name EOF ``` @@ -269,6 +275,8 @@ leo-claude-mktplace/ |----------|-------------| | [CLAUDE.md](./CLAUDE.md) | Main project instructions | | [CONFIGURATION.md](./docs/CONFIGURATION.md) | Centralized setup guide | +| [COMMANDS-CHEATSHEET.md](./docs/COMMANDS-CHEATSHEET.md) | All commands quick reference | +| [UPDATING.md](./docs/UPDATING.md) | Update guide for the marketplace | | [CANONICAL-PATHS.md](./docs/CANONICAL-PATHS.md) | Authoritative path reference | | [CHANGELOG.md](./CHANGELOG.md) | Version history | diff --git a/plugins/projman/commands/initial-setup.md b/plugins/projman/commands/initial-setup.md index 8875a1c..3c82137 100644 --- a/plugins/projman/commands/initial-setup.md +++ b/plugins/projman/commands/initial-setup.md @@ -225,11 +225,13 @@ Use AskUserQuestion: Read the config file and verify it has non-placeholder values: ```bash -source ~/.config/claude/gitea.env && echo "URL: $GITEA_URL" && echo "ORG: $GITEA_ORG" && echo "TOKEN_LENGTH: ${#GITEA_TOKEN}" +source ~/.config/claude/gitea.env && echo "URL: $GITEA_URL" && echo "TOKEN_LENGTH: ${#GITEA_TOKEN}" ``` If TOKEN_LENGTH is less than 10 or contains "PASTE" or "your_", the token hasn't been set properly. +**Note:** GITEA_ORG is configured per-project in `.env`, not in the system-level config. + **Test connectivity (optional but recommended):** ```bash