yw-jenkins-cli 0.1.0__tar.gz

yw_jenkins_cli-0.1.0/.gitignore

@@ -0,0 +1,21 @@
+# Byte-compiled
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+dist/
+build/
+*.egg
+
+# Environment
+.env
+.venv/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# Credentials (never commit!)
+.jenkins-ywwl

yw_jenkins_cli-0.1.0/PKG-INFO

@@ -0,0 +1,134 @@
+Metadata-Version: 2.4
+Name: yw-jenkins-cli
+Version: 0.1.0
+Summary: A simple Jenkins CI/CD CLI tool for triggering builds, monitoring status, and streaming logs
+License-Expression: MIT
+Requires-Python: >=3.11
+Requires-Dist: click>=8.0
+Requires-Dist: httpx>=0.28.0
+Provides-Extra: dev
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# yw-cicd — Jenkins CI/CD CLI
+
+简洁的 Jenkins 命令行工具，一条命令管理构建部署。支持任意 Jenkins 实例。
+
+## 安装
+
+```bash
+pip install yw-jenkins-cli
+```
+
+## 配置
+
+首次使用需要配置 Jenkins 连接信息（三选一）：
+
+**方式一：配置文件（推荐）**
+
+```bash
+cat > ~/.jenkins-cli << 'EOF'
+JENKINS_URL=https://your-jenkins.example.com
+JENKINS_USER=your-username
+JENKINS_TOKEN=your-api-token
+EOF
+chmod 600 ~/.jenkins-cli
+```
+
+**方式二：环境变量**
+
+```bash
+export JENKINS_URL="https://your-jenkins.example.com"
+export JENKINS_USER="your-username"
+export JENKINS_TOKEN="your-api-token"
+```
+
+**方式三：一键安装脚本**（从源码安装时，自动引导配置）
+
+```bash
+git clone <repo-url> && cd yw-jenkins-cli && bash setup.sh
+```
+
+> **API Token 获取方式**: 打开 `<你的Jenkins>/me/configure` → API Token → Add new Token
+
+验证配置：
+
+```bash
+yw-cicd auth
+```
+
+## 命令一览
+
+```bash
+yw-cicd list [FILTER]           # 列出任务（支持正则过滤）
+yw-cicd info <任务名>            # 查看任务参数
+yw-cicd build <任务名> K=V ...   # 触发构建
+yw-cicd status <任务名> [构建号]  # 查看构建状态
+yw-cicd history <任务名> [-n N]  # 构建历史
+yw-cicd log <任务名> <构建号>     # 查看构建日志
+yw-cicd stop <任务名> <构建号>    # 停止构建
+yw-cicd auth                    # 验证认证
+```
+
+## 常见场景
+
+### 部署项目
+
+```bash
+# 1. 查看有哪些参数
+yw-cicd info my-web-project
+
+# 2. 触发构建（等待完成 + 实时日志）
+yw-cicd build my-web-project ENV=test BranchName=master --follow-log
+```
+
+### 查看最近构建
+
+```bash
+yw-cicd history my-web-project -n 5
+```
+
+### 排查构建失败
+
+```bash
+yw-cicd status my-web-project       # 查看最近状态
+yw-cicd log my-web-project 42       # 查看失败日志
+```
+
+### 搜索任务
+
+```bash
+yw-cicd list order           # 搜索包含 "order" 的任务
+yw-cicd list "web|frontend"  # 正则搜索
+```
+
+## Claude Code 集成
+
+项目附带 Claude Code Skill（`skill/SKILL.md`），安装后可在 Claude Code 中直接对话操作 Jenkins：
+
+```bash
+# 安装 Skill
+mkdir -p ~/.claude/skills/yw-cicd
+cp skill/SKILL.md ~/.claude/skills/yw-cicd/
+```
+
+之后直接对 Claude 说：
+- "部署 my-project 到 test 环境"
+- "查看 xxx 最近的构建"
+- "构建失败了，帮我看下日志"
+
+## 项目结构
+
+```
+yw-jenkins-cli/
+├── setup.sh                    # 一键安装脚本
+├── pyproject.toml
+├── src/jenkins_cli/
+│   ├── cli.py                  # CLI 入口（click）
+│   ├── client.py               # Jenkins API 客户端（httpx）
+│   └── config.py               # 认证配置
+├── skill/
+│   └── SKILL.md                # Claude Code Skill
+└── tests/
+```

yw_jenkins_cli-0.1.0/README.md

@@ -0,0 +1,121 @@
+# yw-cicd — Jenkins CI/CD CLI
+
+简洁的 Jenkins 命令行工具，一条命令管理构建部署。支持任意 Jenkins 实例。
+
+## 安装
+
+```bash
+pip install yw-jenkins-cli
+```
+
+## 配置
+
+首次使用需要配置 Jenkins 连接信息（三选一）：
+
+**方式一：配置文件（推荐）**
+
+```bash
+cat > ~/.jenkins-cli << 'EOF'
+JENKINS_URL=https://your-jenkins.example.com
+JENKINS_USER=your-username
+JENKINS_TOKEN=your-api-token
+EOF
+chmod 600 ~/.jenkins-cli
+```
+
+**方式二：环境变量**
+
+```bash
+export JENKINS_URL="https://your-jenkins.example.com"
+export JENKINS_USER="your-username"
+export JENKINS_TOKEN="your-api-token"
+```
+
+**方式三：一键安装脚本**（从源码安装时，自动引导配置）
+
+```bash
+git clone <repo-url> && cd yw-jenkins-cli && bash setup.sh
+```
+
+> **API Token 获取方式**: 打开 `<你的Jenkins>/me/configure` → API Token → Add new Token
+
+验证配置：
+
+```bash
+yw-cicd auth
+```
+
+## 命令一览
+
+```bash
+yw-cicd list [FILTER]           # 列出任务（支持正则过滤）
+yw-cicd info <任务名>            # 查看任务参数
+yw-cicd build <任务名> K=V ...   # 触发构建
+yw-cicd status <任务名> [构建号]  # 查看构建状态
+yw-cicd history <任务名> [-n N]  # 构建历史
+yw-cicd log <任务名> <构建号>     # 查看构建日志
+yw-cicd stop <任务名> <构建号>    # 停止构建
+yw-cicd auth                    # 验证认证
+```
+
+## 常见场景
+
+### 部署项目
+
+```bash
+# 1. 查看有哪些参数
+yw-cicd info my-web-project
+
+# 2. 触发构建（等待完成 + 实时日志）
+yw-cicd build my-web-project ENV=test BranchName=master --follow-log
+```
+
+### 查看最近构建
+
+```bash
+yw-cicd history my-web-project -n 5
+```
+
+### 排查构建失败
+
+```bash
+yw-cicd status my-web-project       # 查看最近状态
+yw-cicd log my-web-project 42       # 查看失败日志
+```
+
+### 搜索任务
+
+```bash
+yw-cicd list order           # 搜索包含 "order" 的任务
+yw-cicd list "web|frontend"  # 正则搜索
+```
+
+## Claude Code 集成
+
+项目附带 Claude Code Skill（`skill/SKILL.md`），安装后可在 Claude Code 中直接对话操作 Jenkins：
+
+```bash
+# 安装 Skill
+mkdir -p ~/.claude/skills/yw-cicd
+cp skill/SKILL.md ~/.claude/skills/yw-cicd/
+```
+
+之后直接对 Claude 说：
+- "部署 my-project 到 test 环境"
+- "查看 xxx 最近的构建"
+- "构建失败了，帮我看下日志"
+
+## 项目结构
+
+```
+yw-jenkins-cli/
+├── setup.sh                    # 一键安装脚本
+├── pyproject.toml
+├── src/jenkins_cli/
+│   ├── cli.py                  # CLI 入口（click）
+│   ├── client.py               # Jenkins API 客户端（httpx）
+│   └── config.py               # 认证配置
+├── skill/
+│   └── SKILL.md                # Claude Code Skill
+└── tests/
+```

yw_jenkins_cli-0.1.0/pyproject.toml

@@ -0,0 +1,24 @@
+[project]
+name = "yw-jenkins-cli"
+version = "0.1.0"
+description = "A simple Jenkins CI/CD CLI tool for triggering builds, monitoring status, and streaming logs"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.11"
+dependencies = [
+    "click>=8.0",
+    "httpx>=0.28.0",
+]
+
+[project.scripts]
+yw-cicd = "jenkins_cli.cli:cli"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/jenkins_cli"]
+
+[project.optional-dependencies]
+dev = ["pytest", "ruff"]

yw_jenkins_cli-0.1.0/setup.sh

@@ -0,0 +1,136 @@
+#!/usr/bin/env bash
+# yw-cicd 一键安装脚本
+# 用法: bash setup.sh
+set -euo pipefail
+
+GREEN='\033[0;32m'
+YELLOW='\033[1;33m'
+RED='\033[0;31m'
+NC='\033[0m'
+
+info()  { echo -e "${GREEN}✓${NC} $1"; }
+warn()  { echo -e "${YELLOW}⚠${NC} $1"; }
+error() { echo -e "${RED}✗${NC} $1"; }
+
+REPO_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+SKILL_DIR="$HOME/.claude/skills/yw-cicd"
+CONFIG_FILE="$HOME/.jenkins-cli"
+
+echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
+echo "  yw-cicd 安装向导"
+echo "  Jenkins CI/CD CLI"
+echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
+echo
+
+# ── Step 1: 检查 Python ──────────────────────────────────────────
+echo "【1/4】检查 Python 环境..."
+if ! command -v python3 &>/dev/null; then
+    error "未找到 python3，请先安装 Python 3.11+"
+    exit 1
+fi
+
+PY_VERSION=$(python3 -c "import sys; print(f'{sys.version_info.major}.{sys.version_info.minor}')")
+PY_MAJOR=$(echo "$PY_VERSION" | cut -d. -f1)
+PY_MINOR=$(echo "$PY_VERSION" | cut -d. -f2)
+
+if [[ "$PY_MAJOR" -lt 3 ]] || [[ "$PY_MAJOR" -eq 3 && "$PY_MINOR" -lt 11 ]]; then
+    error "Python 版本 $PY_VERSION 过低，需要 3.11+"
+    exit 1
+fi
+info "Python $PY_VERSION"
+
+# ── Step 2: 安装 CLI ─────────────────────────────────────────────
+echo
+echo "【2/4】安装 yw-cicd CLI..."
+cd "$REPO_DIR"
+pip install -e . -q 2>&1 | tail -1
+if command -v yw-cicd &>/dev/null; then
+    info "CLI 安装成功: $(which yw-cicd)"
+else
+    error "CLI 安装失败，请检查 pip 输出"
+    exit 1
+fi
+
+# ── Step 3: 配置认证 ─────────────────────────────────────────────
+echo
+echo "【3/4】配置 Jenkins 认证..."
+
+if [[ -f "$CONFIG_FILE" ]]; then
+    info "已有配置文件: $CONFIG_FILE"
+    if yw-cicd auth &>/dev/null; then
+        info "认证有效"
+    else
+        warn "配置文件存在但认证失败，请重新配置"
+        rm -f "$CONFIG_FILE"
+    fi
+fi
+
+if [[ ! -f "$CONFIG_FILE" ]]; then
+    echo
+    read -rp "  请输入 Jenkins URL (如 https://jenkins.example.com): " jenkins_url
+    echo
+    echo "  请在浏览器打开: ${jenkins_url}/me/configure"
+    echo "  → 找到 API Token 部分 → 点击 Add new Token → 复制 token"
+    echo
+    read -rp "  请输入你的 Jenkins 用户名: " jenkins_user
+    read -rp "  请输入你的 API Token: " jenkins_token
+
+    if [[ -z "$jenkins_url" || -z "$jenkins_user" || -z "$jenkins_token" ]]; then
+        error "URL、用户名和 Token 不能为空"
+        exit 1
+    fi
+
+    # 去掉末尾斜杠
+    jenkins_url="${jenkins_url%/}"
+
+    cat > "$CONFIG_FILE" << EOF
+JENKINS_URL=${jenkins_url}
+JENKINS_USER=${jenkins_user}
+JENKINS_TOKEN=${jenkins_token}
+EOF
+    chmod 600 "$CONFIG_FILE"
+    info "配置已写入: $CONFIG_FILE (权限 600)"
+
+    if yw-cicd auth &>/dev/null; then
+        FULL_NAME=$(yw-cicd auth 2>/dev/null | python3 -c "import sys,json; print(json.load(sys.stdin)['fullName'])" 2>/dev/null || echo "")
+        info "认证成功！欢迎, ${FULL_NAME:-$jenkins_user}"
+    else
+        error "认证失败，请检查 URL、用户名和 Token 是否正确"
+        rm -f "$CONFIG_FILE"
+        exit 1
+    fi
+fi
+
+# ── Step 4: 安装 Claude Code Skill (可选) ────────────────────────
+echo
+echo "【4/4】安装 Claude Code Skill..."
+
+if command -v claude &>/dev/null; then
+    mkdir -p "$SKILL_DIR"
+    if [[ -f "$REPO_DIR/skill/SKILL.md" ]]; then
+        cp "$REPO_DIR/skill/SKILL.md" "$SKILL_DIR/SKILL.md"
+        info "Skill 已安装到: $SKILL_DIR"
+    else
+        warn "Skill 文件未找到，跳过 (不影响 CLI 使用)"
+    fi
+else
+    warn "未检测到 Claude Code，跳过 Skill 安装 (不影响 CLI 使用)"
+fi
+
+# ── 完成 ─────────────────────────────────────────────────────────
+echo
+echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
+echo "  ✅ 安装完成！"
+echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
+echo
+echo "  常用命令:"
+echo "    yw-cicd list              # 列出所有任务"
+echo "    yw-cicd list <关键词>      # 按关键词搜索"
+echo "    yw-cicd info <任务名>      # 查看构建参数"
+echo "    yw-cicd build <任务名> KEY=VALUE ..."
+echo "    yw-cicd status <任务名>    # 最近一次构建状态"
+echo "    yw-cicd history <任务名>   # 构建历史"
+echo "    yw-cicd log <任务名> <构建号>"
+echo
+echo "  更多用法: yw-cicd --help"
+echo

yw_jenkins_cli-0.1.0/skill/SKILL.md

@@ -0,0 +1,120 @@
+---
+name: yw-cicd
+description: |
+  Jenkins CI/CD 操作工具（cicd.ywwl.com），通过 yw-cicd CLI 管理构建与部署。
+  触发：用户提到"部署"、"发布"、"构建"、"deploy"、"build"、"trigger" + 项目名；
+  "构建状态"、"构建日志"、"构建历史"、"build status"、"build log"；
+  "停止构建"、"取消构建"、"stop build"、"abort build"；
+  "列出 Jenkins 任务"、"list Jenkins jobs"、"Jenkins 上有哪些项目"；
+  或出现 DEV-WEB-*、DEV-e-commerce-*、TEST_DEV-WEB-* 等任务名前缀时触发。
+  不触发：GitHub Release 发布流程（使用 release skill）；与 cicd.ywwl.com 无关的 CI/CD 讨论。
+---
+
+# Jenkins CI/CD 操作 (cicd.ywwl.com)
+
+通过 `yw-cicd` CLI 工具操作 Jenkins。所有命令输出结构化 JSON。
+
+## 前置检查
+
+每次操作前确认：
+
+```bash
+# 1. CLI 是否可用
+which yw-cicd || (cd ~/Development/projects/self/yw-jenkins-cli && pip install -e .)
+
+# 2. 认证是否有效
+yw-cicd auth
+```
+
+认证失败时，引导用户：
+- 创建 API Token: https://cicd.ywwl.com/me/configure → API Token → Add new Token
+- 配置到 `~/.jenkins-ywwl` 或环境变量 `JENKINS_USER` / `JENKINS_TOKEN`
+
+## 命令速查
+
+| 命令 | 用途 | 示例 |
+|------|------|------|
+| `yw-cicd list [FILTER]` | 列出任务（正则过滤）| `yw-cicd list DEV-WEB` |
+| `yw-cicd info JOB` | 查看任务参数 | `yw-cicd info DEV-WEB-xiaoy-zhibo-wx` |
+| `yw-cicd build JOB [PARAMS...]` | 触发构建 | `yw-cicd build JOB ENV=test BranchName=master` |
+| `yw-cicd status JOB [NUMBER]` | 构建状态 | `yw-cicd status JOB` (默认最近一次) |
+| `yw-cicd history JOB [-n N]` | 构建历史 | `yw-cicd history JOB -n 5` |
+| `yw-cicd log JOB NUMBER [--follow]` | 构建日志 | `yw-cicd log JOB 42 --follow` |
+| `yw-cicd stop JOB NUMBER` | 停止构建 | `yw-cicd stop JOB 42` |
+| `yw-cicd auth` | 验证认证 | `yw-cicd auth` |
+
+## 核心工作流
+
+### 工作流 1: 触发构建并监控（部署/发布）
+
+这是最常见的操作，**必须按顺序执行**：
+
+1. **获取任务参数** — `yw-cicd info <job>`
+2. **展示参数给用户确认** — 列出所有参数的 choices/默认值，让用户选择
+3. **用户确认后触发** — `yw-cicd build <job> KEY1=val1 KEY2=val2 --wait --follow-log`
+   - `--wait`: 等待构建完成（默认）
+   - `--follow-log`: 实时流式输出日志
+   - `--no-wait`: 仅触发不等待
+4. **报告结果** — 成功/失败 + 耗时
+
+**关键规则**: 触发构建前 **必须** 先 `info` 展示参数，与用户确认后才执行。这是不可逆操作。
+
+### 工作流 2: 查看构建状态/历史
+
+```bash
+# 最近一次构建
+yw-cicd status <job>
+
+# 最近 N 次构建
+yw-cicd history <job> -n 5
+```
+
+### 工作流 3: 排查构建失败
+
+1. `yw-cicd history <job>` — 找到失败的构建号
+2. `yw-cicd log <job> <number>` — 获取完整日志
+3. 分析日志中的错误信息，向用户解释原因和建议
+
+### 工作流 4: 停止构建
+
+1. `yw-cicd status <job>` — 确认 `building: true`
+2. 与用户确认是否停止（不可逆）
+3. `yw-cicd stop <job> <number>`
+4. 再次 `status` 确认已停止
+
+## 决策树
+
+```
+用户请求
+├─ 提到具体任务名
+│  ├─ "部署/发布/构建/build/deploy" → 工作流 1（触发构建）
+│  ├─ "状态/结果/status" → 工作流 2（查看状态）
+│  ├─ "日志/log/报错/失败" → 工作流 3（排查失败）
+│  ├─ "停止/取消/stop/abort" → 工作流 4（停止构建）
+│  └─ "参数/详情/info" → yw-cicd info
+├─ 未提到具体任务名
+│  ├─ "列出/list/有哪些" → yw-cicd list
+│  ├─ "搜索/查找 xxx" → yw-cicd list <filter>
+│  └─ 模糊描述 → 先 yw-cicd list 帮用户定位任务名
+└─ 讨论性问题 → 直接回答，不调用命令
+```
+
+## 任务命名规范
+
+| 前缀 | 含义 |
+|------|------|
+| `DEV-WEB-*` | 前端 Web 项目（开发/测试环境）|
+| `DEV-WEB-ywCloud-*` | 云平台相关前端 |
+| `DEV-WEB-YWFE-BIZ-*` | 业务前端项目 |
+| `DEV-e-commerce-*` | 电商相关项目 |
+| `TEST_DEV-WEB-*` | 测试环境变体 |
+| 中文名（如 `cdn刷新`）| 特殊工具类任务 |
+
+用户提到项目名但未使用完整前缀时，用 `yw-cicd list <关键词>` 模糊匹配。
+
+## 错误处理
+
+- **认证失败 (401/403)**: 引导用户检查 `~/.jenkins-ywwl` 或到 `/me/configure` 重新生成 Token
+- **任务不存在 (404)**: 用 `yw-cicd list` 搜索相似名称
+- **队列超时**: 提示执行器可能繁忙，建议查看 Jenkins 面板
+- **CLI 未安装**: `cd ~/Development/projects/self/yw-jenkins-cli && pip install -e .`

yw_jenkins_cli-0.1.0/src/jenkins_cli/__init__.py

@@ -0,0 +1,3 @@
+"""Jenkins CI/CD CLI tool for cicd.ywwl.com."""
+
+__version__ = "0.1.0"