python-jcli 0.1.0__py3-none-any.whl

jcli/skills/jcli/plugin/SKILL.md

@@ -0,0 +1,51 @@
+---
+name: jcli-plugin
+version: 1.0.0
+description: |
+  jcli 插件管理 - 管理 Jenkins 插件的安装、卸载、查看等操作。
+allowed-tools:
+  - Bash
+  - Read
+---
+
+# jcli-plugin
+
+管理 Jenkins 插件的安装、卸载、查看等操作。
+
+## 前提条件
+
+- Python >= 3.10
+- Jenkins 2.x 或更高版本
+- 已安装 jcli：`pip install -e /data/git-project/jcli`
+
+## 命令参考
+
+```bash
+jcli plugin list                           # 列出已安装插件
+jcli plugin get <name>                     # 查看插件详情
+jcli plugin install <name>                 # 安装插件
+jcli plugin install git@4.15.0             # 安装指定版本
+jcli plugin uninstall <name>               # 卸载插件
+```
+
+## 常见用例
+
+### 查看已安装插件
+
+```bash
+# 列出所有插件
+jcli plugin list
+
+# 查看特定插件详情
+jcli plugin get git
+```
+
+### 安装插件
+
+```bash
+# 安装最新版本
+jcli plugin install git
+
+# 安装指定版本
+jcli plugin install git@4.15.0
+```

jcli/skills/jcli/system/SKILL.md

@@ -0,0 +1,70 @@
+---
+name: jcli-system
+version: 1.0.0
+description: |
+  jcli 系统管理 - 管理 Jenkins 系统信息查看、重启、安静模式等操作。
+allowed-tools:
+  - Bash
+  - Read
+---
+
+# jcli-system
+
+管理 Jenkins 系统信息查看、重启、安静模式等操作。
+
+## 前提条件
+
+- Python >= 3.10
+- Jenkins 2.x 或更高版本
+- 已安装 jcli：`pip install -e /data/git-project/jcli`
+
+## 命令参考
+
+```bash
+jcli system info                           # 查看系统信息
+jcli system load                           # 查看系统负载
+jcli system restart                        # 安全重启 Jenkins
+jcli system quiet-down                     # 进入安静模式
+jcli system quiet-down --reason "维护"     # 带原因的安静模式
+jcli system cancel-quiet-down              # 取消安静模式
+jcli system script "println('hello')"      # 执行 Groovy 脚本
+```
+
+## 常见用例
+
+### 查看系统状态
+
+```bash
+# 查看系统版本和统计信息
+jcli system info
+
+# 查看队列长度和执行器数量
+jcli system load
+```
+
+### 维护模式
+
+```bash
+# 进入安静模式（不接受新构建）
+jcli system quiet-down --reason "系统升级"
+
+# 取消安静模式
+jcli system cancel-quiet-down
+```
+
+### 重启 Jenkins
+
+```bash
+# 安全重启（等待当前构建完成）
+jcli system restart
+```
+
+### 执行 Groovy 脚本
+
+```bash
+# 执行简单的 Groovy 脚本
+jcli system script "println('Hello from jcli')"
+
+# 获取所有节点信息
+jcli system script "Jenkins.instance.computers.each { println it.name }"
+```

jcli/skills/jcli/view/SKILL.md

@@ -0,0 +1,47 @@
+---
+name: jcli-view
+version: 1.0.0
+description: |
+  jcli 视图管理 - 管理 Jenkins 视图的创建、删除、查看等操作。
+allowed-tools:
+  - Bash
+  - Read
+---
+
+# jcli-view
+
+管理 Jenkins 视图的创建、删除、查看等操作。
+
+## 前提条件
+
+- Python >= 3.10
+- Jenkins 2.x 或更高版本
+- 已安装 jcli：`pip install -e /data/git-project/jcli`
+
+## 命令参考
+
+```bash
+jcli view list                             # 列出所有视图
+jcli view get <name>                       # 查看视图详情
+jcli view create <name> -f config.xml      # 从 XML 创建视图
+jcli view delete <name>                    # 删除视图
+```
+
+## 常见用例
+
+### 查看视图
+
+```bash
+# 列出所有视图
+jcli view list
+
+# 查看特定视图详情
+jcli view get my-view
+```
+
+### 创建视图
+
+```bash
+# 从 XML 配置文件创建视图
+jcli view create my-view -f view-config.xml
+```

python_jcli-0.1.0.dist-info/METADATA

@@ -0,0 +1,311 @@
+Metadata-Version: 2.4
+Name: python-jcli
+Version: 0.1.0
+Summary: Python Jenkins CLI tool
+License: MIT
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: click>=8.1.0
+Requires-Dist: requests~=2.31.0
+Requires-Dist: pyyaml~=6.0.1
+Requires-Dist: rich>=13.7.1
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0; extra == "dev"
+Requires-Dist: responses>=0.23.0; extra == "dev"
+
+# jcli
+
+A command-line tool for managing Jenkins servers. jcli wraps the Jenkins REST API into readable commands that work the way you'd expect, with table, JSON, and YAML output options.
+
+[中文文档](README-zh.md)
+
+## Features
+
+- **8 command modules** covering jobs, builds, nodes, plugins, credentials, pipelines, views, and system management
+- **Multiple output formats**: human-readable tables (default, via Rich), JSON, and YAML
+- **Multi-profile support** via `~/.jcli/config.yaml` with environment variable overrides
+- **Automatic CSRF (Crumb) handling** for Jenkins servers with CSRF protection enabled
+- **Built with Click and Rich** for a polished terminal experience
+
+## Requirements
+
+- Python 3.10 or later
+- A Jenkins server running Jenkins 2.x or later
+
+## Installation
+
+Install from source with pip:
+
+```bash
+pip install .
+```
+
+Or in editable mode for development:
+
+```bash
+pip install -e ".[dev]"
+```
+
+After installation, `jcli` is available as a console script.
+
+## Quick Start
+
+### 1. Configure your Jenkins connection
+
+Create a configuration file at `~/.jcli/config.yaml`:
+
+```yaml
+active_profile: default
+profiles:
+  default:
+    url: https://jenkins.example.com
+    username: admin
+    api_token: "11abcdef0123456789abcdef0123456789ab"
+    description: "Production Jenkins"
+```
+
+If the file doesn't exist, jcli creates it with a template on first run.
+
+To generate an API token, go to your Jenkins user page: **Your Username > Configure > API Token > Add new Token**.
+
+### 2. Run your first command
+
+```bash
+jcli job list
+```
+
+If your server is configured correctly, this prints a table of all Jenkins jobs.
+
+## Configuration
+
+### Config file
+
+jcli stores profiles in `~/.jcli/config.yaml`. Each profile has four fields:
+
+| Field        | Description                |
+|-------------|----------------------------|
+| `url`       | Jenkins server URL          |
+| `username`  | Jenkins username            |
+| `api_token` | Jenkins API token           |
+| `description` | Human-readable description |
+
+The `active_profile` key selects which profile to use.
+
+To add another server profile, edit the file and add a new entry under `profiles`:
+
+```yaml
+active_profile: prod
+profiles:
+  prod:
+    url: https://jenkins.prod.example.com
+    username: admin
+    api_token: "..."
+    description: "Production"
+  staging:
+    url: https://jenkins.staging.example.com
+    username: admin
+    api_token: "..."
+    description: "Staging"
+```
+
+### Environment variables
+
+Environment variables override config file values. This is useful in CI pipelines.
+
+| Variable          | Overrides           |
+|-------------------|---------------------|
+| `JCLI_URL`        | `url`               |
+| `JCLI_USERNAME`   | `username`          |
+| `JCLI_API_TOKEN`  | `api_token`         |
+| `JCLI_PROFILE`    | `active_profile`    |
+
+Set `JCLI_PROFILE` to select a profile without editing the config file.
+
+### CLI options
+
+Profile and server can also be set with command-line flags:
+
+```bash
+jcli -p staging job list          # use the "staging" profile
+jcli -s https://ci.example.com job list   # override server URL
+jcli -d job list                  # enable debug logging
+```
+
+Run `jcli --help` for the full option list.
+
+## Command Reference
+
+### Global options
+
+Every command accepts these global flags before the subcommand:
+
+```
+-d, --debug                     Enable debug output
+-f, --format [table|json|yaml]  Output format (default: table)
+-p, --profile TEXT              Configuration profile name
+-s, --server TEXT               Jenkins server URL
+```
+
+### job — Manage Jenkins jobs
+
+```
+jcli job list                               List all jobs
+jcli job get JOB_NAME                       Show details for a specific job
+jcli job create JOB_NAME -f job-config.xml  Create a new job from XML config file
+jcli job config JOB_NAME                    Print the XML configuration of a job
+jcli job copy SOURCE_JOB NEW_NAME           Copy a job to a new name
+jcli job enable JOB_NAME                    Enable a disabled job
+jcli job disable JOB_NAME                   Disable a job
+jcli job delete JOB_NAME                    Delete a job
+```
+
+### build — Manage Jenkins builds
+
+```
+jcli build list JOB_NAME                    List recent builds for a job
+jcli build get JOB_NAME BUILD_NUMBER        Show details for a specific build
+jcli build trigger JOB_NAME                 Trigger a new build
+jcli build log JOB_NAME BUILD_NUMBER        Show console log for a build
+jcli build stop JOB_NAME BUILD_NUMBER       Stop a running build
+jcli build queue                            Show the current build queue
+```
+
+### node — Manage Jenkins nodes (agents)
+
+```
+jcli node list                              List all nodes
+jcli node get NODE_NAME                     Get details of a specific node
+jcli node delete NODE_NAME                  Delete a node
+jcli node toggle NODE_NAME --offline        Take a node offline
+jcli node toggle NODE_NAME --online         Bring a node back online
+```
+
+### plugin — Manage Jenkins plugins
+
+```
+jcli plugin list                            List installed plugins
+jcli plugin get PLUGIN_NAME                 Show details for a single plugin
+jcli plugin install PLUGIN_NAME             Install a plugin
+jcli plugin uninstall PLUGIN_NAME           Uninstall a plugin
+```
+
+### credential — Manage Jenkins credentials
+
+```
+jcli credential list                        List credentials
+jcli credential get CREDENTIAL_NAME         Get credential details
+jcli credential create -f cred-config.xml   Create a credential from XML config
+jcli credential delete CREDENTIAL_NAME      Delete a credential
+```
+
+### pipeline — Manage Jenkins pipelines
+
+```
+jcli pipeline stages JOB_NAME BUILD_NUMBER  List stages for a Pipeline build
+jcli pipeline log JOB_NAME BUILD_NUMBER     Get log output for a Pipeline step
+jcli pipeline pending JOB_NAME BUILD_NUMBER Show pending input actions
+jcli pipeline validate -f Jenkinsfile       Validate a Jenkinsfile against the server
+```
+
+### view — Manage Jenkins views
+
+```
+jcli view list                              List all views
+jcli view get VIEW_NAME                     Get details for a view
+jcli view create -f view-config.xml         Create a view from XML config
+jcli view delete VIEW_NAME                  Delete a view
+```
+
+### system — Jenkins system information and management
+
+```
+jcli system info                            Show system version and stats
+jcli system load                            Show queue length and executor counts
+jcli system quiet-down                      Put Jenkins into quiet-down mode
+jcli system cancel-quiet-down               Cancel quiet-down mode
+jcli system restart                         Trigger a safe restart
+jcli system script "println('hello')"       Execute a Groovy script on the server
+```
+
+## Output Formats
+
+jcli supports three output formats, selectable with `-f` / `--format`:
+
+```bash
+jcli -f table job list    # Rich-formatted table (default)
+jcli -f json  job list    # JSON output
+jcli -f yaml  job list    # YAML output
+```
+
+Table mode uses the [Rich](https://github.com/Textualize/rich) library with alternating row colors and auto-width columns. Pipe the output to any file or command as needed.
+
+## Development
+
+### Setup
+
+```bash
+git clone <repo-url> jcli
+cd jcli
+pip install -e ".[dev]"
+```
+
+### Running tests
+
+The test suite uses pytest with the `responses` library for HTTP mocking:
+
+```bash
+pytest
+```
+
+For coverage:
+
+```bash
+pytest --cov=jcli --cov-report=term-missing
+```
+
+### Project structure
+
+```
+jcli/
+  cli.py              Main CLI entry point (Click group)
+  __init__.py         Version
+  plugins/            Command modules (one per Jenkins domain)
+    job.py
+    build.py
+    node.py
+    plugin.py
+    credential.py
+    pipeline.py
+    view.py
+    system.py
+  sdk/                Shared libraries
+    client.py         Jenkins REST API client (HTTP, auth, crumb)
+    config.py         Configuration management (YAML, env vars)
+    output/
+      formatter.py    Table/JSON/YAML output formatting
+    exceptions.py     Typed exceptions
+tests/                pytest test suite
+```
+
+### Dependencies
+
+| Package          | Purpose                     |
+|-----------------|-----------------------------|
+| click >= 8.1.0   | CLI framework               |
+| requests ~= 2.31 | HTTP client                 |
+| pyyaml ~= 6.0.1  | YAML config parsing         |
+| rich >= 13.7.1   | Terminal formatting (tables) |
+| argcomplete >= 3.3 | Shell tab completion       |
+
+Dev dependencies (optional `[dev]` extra):
+
+| Package          | Purpose                     |
+|-----------------|-----------------------------|
+| pytest >= 7.0    | Test runner                 |
+| pytest-cov >= 4.0 | Coverage reporting         |
+| responses >= 0.23 | HTTP response mocking      |
+
+## License
+
+MIT

python_jcli-0.1.0.dist-info/RECORD

@@ -0,0 +1,44 @@
+jcli/__init__.py,sha256=kUR5RAFc7HCeiqdlX36dZOHkUI5wI6V_43RpEcD8b-0,22
+jcli/__main__.py,sha256=ARL8XYr45T4pIf0gnyCCbK8uljcn1LF7TKcFapxHt_k,34
+jcli/cli.py,sha256=Ep6OFwyx4eVdbMbVcXrebPboMQuXarkYuxTILTst3eM,2135
+jcli/cli_helpers.py,sha256=8GsvEwmaqS8p9Rpx7d_b3_i_Pwag8zsJNNbunxgNXS0,1831
+jcli/plugins/__init__.py,sha256=I6vTpfYO3gIwHoNu5V-sOIdpT_g-bAy4RXR3TW3-k1U,1054
+jcli/plugins/build.py,sha256=60F0UPMFy_eZznBeAIM0XwCcQ3pAuJJjacGaCXxOlcI,6032
+jcli/plugins/config.py,sha256=OEl8X5zrYIBRHhBx1s6GokqBZ2yKRLYgMOVJjjbZgho,8302
+jcli/plugins/credential.py,sha256=ZLdKXoU1ZResv0FqWOH6XWNfb5iSi1rg3dFX1VZPd10,6415
+jcli/plugins/job.py,sha256=dq5jbAn8ZjtYNqJlo7u-0iORubMdZMB2sj4GVK01xoU,12872
+jcli/plugins/node.py,sha256=nwUDYvev9R_BOoYHVmNvNp3vhrmZAXVFN2z_-F_iO7I,4776
+jcli/plugins/pipeline.py,sha256=vTtLk0tPiMSwy2CsCEmtQMhbt9baFoxAqGCSyHtOmOc,3049
+jcli/plugins/plugin.py,sha256=0LMaPjr5jpZokOLENt0rDi_Klk4JYcw8uUzZUceDYvk,4713
+jcli/plugins/skills.py,sha256=WAJJN9_r9kgS2FCjoZeeQZhTrU9ZF0zUu3wpLwniHs4,13177
+jcli/plugins/system.py,sha256=2ojwBOsaiuNKmuiTLvU6GpLeSI3-kccy1QjpHuX_8vE,4938
+jcli/plugins/view.py,sha256=eH7pCe7Tw1rC4kVBZDxHqVd3ZrXYLlVxNGPjWvhgw8Q,4475
+jcli/sdk/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+jcli/sdk/build.py,sha256=xNMPOCL-RUBQo7OJDuaIZ-DtnxN15kZbyO_insEiklM,5309
+jcli/sdk/client.py,sha256=hnBZcS82ziPyHepPWq7femUqQppw8QCtwbdMrWYVrxc,8723
+jcli/sdk/config.py,sha256=fSBTWqE0i8jpzmtGfo2M-Ln2Y5eQRQD0StS76glyCsI,6992
+jcli/sdk/credential.py,sha256=ayasSZjfn62Z1E6Rc15mqeqN0LyQ1wzO2OBsmlXY7Kk,4009
+jcli/sdk/exceptions.py,sha256=zv5oYOr_t0rma4lVudLp3gLdL5idSzlKGc7g2MowcL0,1737
+jcli/sdk/job.py,sha256=SLuCWdmKm9Y-hh1-TGGNCtELbFen8o6kt4nn4q1BqGg,4877
+jcli/sdk/job_templates.py,sha256=IDQFvlLjMxDP1sLfZUHSo6karjVKu9rsb3dZlMmXqpM,4021
+jcli/sdk/node.py,sha256=N7VTTxXhZKtik2Pn5tJMLoVkqz7iI5BDc-4o8u_c4Ig,4032
+jcli/sdk/pipeline.py,sha256=NLUNC8thSfHWc9_hf5N6wpeeHNlAFLj74Crb5HZmPG8,3515
+jcli/sdk/plugin.py,sha256=kKmxVPgV66sEUAc9J85-E8edY3qpcTw1M4FY_7OUqW8,4671
+jcli/sdk/system.py,sha256=L5PHlrjs-5_PFFOQ9IBA-vMwgQyqq33TfJidTcs0VSQ,6022
+jcli/sdk/view.py,sha256=5Poo50l3eY9ivef3hs0CyL-K39qDk39XQuX7gEHHRlA,2300
+jcli/sdk/output/__init__.py,sha256=Rt0F77oq24tqHvTDV4HyWKAjDtOyPOh9m7ucFy7B77s,70
+jcli/sdk/output/formatter.py,sha256=OUjQxeD-2iSNncuuRaLa01qLi899ux3F39KNkc8ik2Q,3876
+jcli/skills/jcli/SKILL.md,sha256=DM471dAnNguIzQKHMEBG3u6YafEzh9j3MesR8facQNQ,2384
+jcli/skills/jcli/config/SKILL.md,sha256=AHGfoitHRNPI0PyfKNrmOAG-k55RQOUacrDPfHiVDrI,1728
+jcli/skills/jcli/credential/SKILL.md,sha256=vOo2HWoVwv1IeQqALe7nOhwZ-qp4uLabanB4L8y14h8,943
+jcli/skills/jcli/job/SKILL.md,sha256=x8ytgCuHbwG1sspwLhzsd06AW4nw5M42ioHFqJi8yd8,1322
+jcli/skills/jcli/node/SKILL.md,sha256=E_r4aYjIr213qiTS6KGz08tV08hdsc8tlIzKZucrsts,1034
+jcli/skills/jcli/pipeline/SKILL.md,sha256=0cffcYTy-FzlqffosR-adSR7zne3Yfq08TEn1Yd6eCY,1177
+jcli/skills/jcli/plugin/SKILL.md,sha256=ybzQacz2-k0H9sTm4CwAEG40unT-Ndx1ngFrSv19KwA,986
+jcli/skills/jcli/system/SKILL.md,sha256=d2EkJSQnjaZFQ2MHWniHPxpHLGtZ9iDVy3jC2zev4zw,1538
+jcli/skills/jcli/view/SKILL.md,sha256=e-huIcHxr-A3tKFUkjQIV6mT2O9RKlSmEJ6HJ9NylyI,895
+python_jcli-0.1.0.dist-info/METADATA,sha256=1FUFhHyJ7BY_SC8xws-JjdaXFSBXsuQellAgHE90OWk,9276
+python_jcli-0.1.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+python_jcli-0.1.0.dist-info/entry_points.txt,sha256=g-Gb8voGH3Ru4NEoCUMJXJiMZMapdAfYi6Xt1phyFi4,39
+python_jcli-0.1.0.dist-info/top_level.txt,sha256=WFqrbWSEfhvQfbN2m-_Wi5KKCwv1_23LhzPUqo7AdQc,5
+python_jcli-0.1.0.dist-info/RECORD,,

python_jcli-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

python_jcli-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+jcli = jcli.cli:main

python_jcli-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+jcli