python-jcli 0.1.0__py3-none-any.whl → 1.0.1__py3-none-any.whl

jcli/specs/resources/view.yaml

@@ -0,0 +1,75 @@
+name: view
+description: Manage Jenkins views
+methods:
+  list:
+    description: List all Jenkins views
+    http:
+      method: GET
+      path: api/json
+      query:
+        tree: "views[name,url,jobs[name]]"
+    output:
+      items_path: $.views
+      fields:
+        - name: name
+          alias: Name
+        - name: url
+          alias: URL
+        - name: jobs
+          alias: Jobs
+  get:
+    description: Get details for a view
+    http:
+      method: GET
+      path: "view/{{ name }}/api/json"
+    params:
+      path:
+        - name: name
+          type: string
+          argument: true
+  create:
+    description: Create a view from XML config
+    http:
+      method: POST
+      path: createView
+      query:
+        name: '{{ name }}'
+      headers:
+        Content-Type: application/xml
+      body: '{{ config_xml }}'
+    params:
+      query:
+        - name: name
+          type: string
+          argument: true
+      body:
+        - name: config_xml
+          type: file
+          argument: true
+  update:
+    description: Update a view's configuration
+    http:
+      method: POST
+      path: "view/{{ name }}/config.xml"
+      headers:
+        Content-Type: application/xml
+      body: '{{ config_xml }}'
+    params:
+      path:
+        - name: name
+          type: string
+          argument: true
+      body:
+        - name: config_xml
+          type: file
+          argument: true
+  delete:
+    description: Delete a view
+    http:
+      method: POST
+      path: "view/{{ name }}/doDelete"
+    params:
+      path:
+        - name: name
+          type: string
+          argument: true

{python_jcli-0.1.0.dist-info → python_jcli-1.0.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-jcli
-Version: 0.1.0
+Version: 1.0.1
 Summary: Python Jenkins CLI tool
 License: MIT
 Requires-Python: >=3.10
@@ -9,6 +9,7 @@ Requires-Dist: click>=8.1.0
 Requires-Dist: requests~=2.31.0
 Requires-Dist: pyyaml~=6.0.1
 Requires-Dist: rich>=13.7.1
+Requires-Dist: cliyard>=0.6.0
 Provides-Extra: dev
 Requires-Dist: pytest>=7.0; extra == "dev"
 Requires-Dist: pytest-cov>=4.0; extra == "dev"
@@ -23,10 +24,38 @@ A command-line tool for managing Jenkins servers. jcli wraps the Jenkins REST AP
 ## Features
 
 - **8 command modules** covering jobs, builds, nodes, plugins, credentials, pipelines, views, and system management
+- **Spec-driven CLI**: commands are declared as cliyard YAML specs in `specs/` and generated at runtime, no hand-written Click groups
 - **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
+- **Built on cliyard and Rich** for a polished, maintainable terminal experience
+
+## Architecture
+
+jcli 2.0 is driven by [cliyard](https://pypi.org/project/cliyard/) YAML specs instead of hand-written Click command groups. At startup, `jcli/cli.py` locates the spec directory (`JCLI_SPEC_DIR` env var > package-local `jcli/specs/`) and calls `cliyard.runtime.create_cli()` to build the whole command tree. Commands stay declarative: adding or changing a command is an edit to a YAML file, not Python plumbing.
+
+```
+jcli/specs/
+  _auth.yaml          Server auth chain (basic auth + crumb, as cliyard plugins)
+  resources/          One YAML spec per Jenkins domain
+    job.yaml          job list/get/create/config/copy/enable/disable/delete
+    build.yaml        build list/get/trigger/replay/log/stop/queue
+    node.yaml         node list/get/delete/toggle
+    plugin.yaml       plugin list/get/install/uninstall
+    credential.yaml   credential list/get/create/delete
+    pipeline.yaml     pipeline stages/log/pending/validate
+    view.yaml         view list/get/create/delete
+    system.yaml       system info/load/quiet-down/restart/script
+  plugins/            Python method plugins for non-trivial logic
+    jcli_commands.py         Skills + completion commands
+    jenkins_auth.py          Basic + crumb authentication
+    jenkins_methods.py       Build trigger/replay, node create
+    jenkins_pipeline_validate.py  Jenkinsfile validation
+    jenkins_plugin.py        Plugin install/uninstall/update-center
+    jenkins_system.py        Groovy script, quiet-down, restart
+```
+
+A resource spec maps a command name to either a plain HTTP call (method, path, params, output mapping) or a `plugin:` reference. The auth chain in `_auth.yaml` injects `Authorization` and crumb headers into every request.
 
 ## Requirements
 
@@ -147,6 +176,21 @@ Every command accepts these global flags before the subcommand:
 -s, --server TEXT               Jenkins server URL
 ```
 
+### auth — Manage authentication profiles
+
+Profiles are stored in `~/.jcli/config.yaml` (token shown masked).
+
+```
+jcli auth add -n NAME -u USER -p TOKEN -e URL     Add (or update) a profile
+jcli auth add -n NAME ... --default               ... and make it active
+jcli auth status                                  List profiles (tokens masked)
+jcli auth use NAME                                Switch the active profile
+jcli auth rm NAME                                 Remove a profile
+jcli auth rm --all                                Remove all profiles (reset template)
+jcli auth set NAME FIELD VALUE                    Set url/username/api_token/description
+jcli auth show [NAME]                             Show a profile's details (default: active)
+```
+
 ### job — Manage Jenkins jobs
 
 ```
@@ -166,6 +210,9 @@ jcli job delete JOB_NAME                    Delete a job
 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 rebuild JOB_NAME BUILD_NUMBER  Rebuild reusing previous parameters
+jcli build rebuild JOB_NAME BUILD_NUMBER --set KEY=VAL   ... and override values (repeatable)
+jcli build replay JOB_NAME BUILD_NUMBER JENKINSFILE   Replay a build with a custom Jenkinsfile
 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
@@ -268,23 +315,20 @@ pytest --cov=jcli --cov-report=term-missing
 
 ```
 jcli/
-  cli.py              Main CLI entry point (Click group)
+  cli.py              Entry point: builds the Click CLI from cliyard YAML specs
+  cli_helpers.py      Output-formatter helper used by the cliyard command plugins
   __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
+  skills/             Bundled skill documentation
+specs/                cliyard YAML specs (command definitions)
+  _auth.yaml          Auth chain: basic + crumb plugins
+  resources/          One YAML per Jenkins domain (job, build, node, ...)
+  plugins/            Python method plugins for non-trivial logic
 tests/                pytest test suite
 ```
 
@@ -293,6 +337,7 @@ tests/                pytest test suite
 | Package          | Purpose                     |
 |-----------------|-----------------------------|
 | click >= 8.1.0   | CLI framework               |
+| cliyard >= 0.6.0 | Spec-driven CLI engine (YAML command generation) |
 | requests ~= 2.31 | HTTP client                 |
 | pyyaml ~= 6.0.1  | YAML config parsing         |
 | rich >= 13.7.1   | Terminal formatting (tables) |

python_jcli-1.0.1.dist-info/RECORD

@@ -0,0 +1,40 @@
+jcli/__init__.py,sha256=d4QHYmS_30j0hPN8NmNPnQ_Z0TphDRbu4MtQj9cT9e8,22
+jcli/__main__.py,sha256=ARL8XYr45T4pIf0gnyCCbK8uljcn1LF7TKcFapxHt_k,34
+jcli/cli.py,sha256=krV91DUIFEQnO_OzS08JahY5GFIQB5Omwvj2YcQVX_Y,21921
+jcli/cli_helpers.py,sha256=xtMiNfoicBnc4g4qi56PJT3S8KwS56up5tOANNE-SmY,610
+jcli/sdk/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+jcli/sdk/client.py,sha256=hnBZcS82ziPyHepPWq7femUqQppw8QCtwbdMrWYVrxc,8723
+jcli/sdk/config.py,sha256=fSBTWqE0i8jpzmtGfo2M-Ln2Y5eQRQD0StS76glyCsI,6992
+jcli/sdk/exceptions.py,sha256=zv5oYOr_t0rma4lVudLp3gLdL5idSzlKGc7g2MowcL0,1737
+jcli/sdk/output/__init__.py,sha256=Rt0F77oq24tqHvTDV4HyWKAjDtOyPOh9m7ucFy7B77s,70
+jcli/sdk/output/formatter.py,sha256=OUjQxeD-2iSNncuuRaLa01qLi899ux3F39KNkc8ik2Q,3876
+jcli/skills/jcli/SKILL.md,sha256=X9xHxRvNa4F3hUN8bhckBXAJZx2MWY58hGqqd0y158M,3040
+jcli/skills/jcli/auth/SKILL.md,sha256=4_DLD51SwKTXh2Xi0UiQbqG4uXw7qIKv2SOOopS2Qn0,1996
+jcli/skills/jcli/build/SKILL.md,sha256=J2UbuAAuAHiIrMbnzLH2Q8mQcRvy3JkuTS9GyhMfR64,3557
+jcli/skills/jcli/credential/SKILL.md,sha256=3VsVdGalsIySvGfFO79IdL0b5OjF7kJBS9_4P56Wt2A,1244
+jcli/skills/jcli/job/SKILL.md,sha256=bmGyiyLXS2n395bA31gehcMRe094SUBq-FzUlUDvpQM,2066
+jcli/skills/jcli/node/SKILL.md,sha256=k4qi6ApspdIlBcxb0v2ItPrPwT7d9AnFq4N-vGhGcqY,1247
+jcli/skills/jcli/pipeline/SKILL.md,sha256=kUwnxBCUx53zi7efVgtJg9ainO-YuX3griaCqoUyzxU,1231
+jcli/skills/jcli/plugin/SKILL.md,sha256=--1t5LekIHAtnCWUnsQ9BKkPIgAQ7n-p7_QGd8H2jbI,1178
+jcli/skills/jcli/system/SKILL.md,sha256=SHdcLbaJyifjt4KJlmdcHdYLsFGwpF-6lqiWdYpw3co,1932
+jcli/skills/jcli/view/SKILL.md,sha256=f2QZEzvFocIlR7Yh0RKnp5y4sijwUJU_1fxiW7gKJcA,1047
+jcli/specs/_auth.yaml,sha256=h4wfmdjIetxCAQGpPHmp89FIRPXHP9N5vwDkw6PIPcc,276
+jcli/specs/plugins/jcli_commands.py,sha256=6d9HEmPeyjwTaY6z9dFUbD7TYjkOn2C4WkUb_J2U1Wc,15878
+jcli/specs/plugins/jenkins_auth.py,sha256=CbjWOHCEUoKpbV4WkRFTUCoPCLF5srHnWIkcIG1TUAA,2714
+jcli/specs/plugins/jenkins_methods.py,sha256=9Rd8xxqXQl8ikKSlB15kgp61Y0UQDgSL7XsY5u5L2-Q,11793
+jcli/specs/plugins/jenkins_pipeline_validate.py,sha256=N7DuQgtam_idKQaPWSsmxa4G4ohf-c8YUn6hLfF-znQ,1868
+jcli/specs/plugins/jenkins_plugin.py,sha256=Bdg1CZI6kHsa1Po3KaR6057ON2t1SmuRt17MvRLc63U,2533
+jcli/specs/plugins/jenkins_system.py,sha256=n_m_c8gHfIXmqUyDSiGZytblDM7H5QQCoDUEBhI30NQ,4289
+jcli/specs/resources/build.yaml,sha256=niDH8L8HSHrIa_u5BMP9FJXgd3i2UWiTXUXOjKzSsM0,3994
+jcli/specs/resources/credential.yaml,sha256=SUTOmYN_lafMAzuhH8noZj3HJgUvwG4FkXytoTcxA-M,2402
+jcli/specs/resources/job.yaml,sha256=jvy-ARhPKCTaEpSyU1bJ7C1_HHo7l_Kb0b8yOku3FHs,4075
+jcli/specs/resources/node.yaml,sha256=FhMEQ1kxucP6XyoTiVys7yoy8y3o-stbBdKv_SgIckA,1594
+jcli/specs/resources/pipeline.yaml,sha256=kk-0B3adC8gA6YaFOOfQ5uAZQ11X3wCfvO-nLTx8hoE,1646
+jcli/specs/resources/plugin.yaml,sha256=pqR5GUi1FHAL8iFsPbGCEr3sKSmR1UwK9CcZR5dLvJI,1561
+jcli/specs/resources/system.yaml,sha256=ZhRcG5FTrKqIz-QNTxhPdO-y0WE29QVo3-U8oiMXYcc,1529
+jcli/specs/resources/view.yaml,sha256=ELWZFZy667gh7SzwXCpxTacaduiqH7n2PAKdqzgnDLw,1596
+python_jcli-1.0.1.dist-info/METADATA,sha256=4sTjfkW2xI6-6Ghz6RacmyZEvO41jBxAULceIVA_xZc,12519
+python_jcli-1.0.1.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
+python_jcli-1.0.1.dist-info/entry_points.txt,sha256=g-Gb8voGH3Ru4NEoCUMJXJiMZMapdAfYi6Xt1phyFi4,39
+python_jcli-1.0.1.dist-info/top_level.txt,sha256=WFqrbWSEfhvQfbN2m-_Wi5KKCwv1_23LhzPUqo7AdQc,5
+python_jcli-1.0.1.dist-info/RECORD,,

{python_jcli-0.1.0.dist-info → python_jcli-1.0.1.dist-info}/WHEEL

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

jcli/plugins/__init__.py

@@ -1,28 +0,0 @@
-"""Jenkins CLI plugins - register all subcommands."""
-
-import click
-
-from jcli.plugins.build import register as register_build
-from jcli.plugins.config import register as register_config
-from jcli.plugins.credential import register as register_credential
-from jcli.plugins.job import register as register_job
-from jcli.plugins.node import register as register_node
-from jcli.plugins.pipeline import register as register_pipeline
-from jcli.plugins.plugin import register as register_plugin
-from jcli.plugins.skills import register as register_skills
-from jcli.plugins.system import register as register_system
-from jcli.plugins.view import register as register_view
-
-
-def register_commands(group: click.Group) -> None:
-    """Register all plugin subcommands under the main CLI group."""
-    register_build(group)
-    register_config(group)
-    register_credential(group)
-    register_job(group)
-    register_node(group)
-    register_pipeline(group)
-    register_plugin(group)
-    register_skills(group)
-    register_system(group)
-    register_view(group)

jcli/plugins/build.py

@@ -1,197 +0,0 @@
-"""Jenkins Build management commands."""
-
-from __future__ import annotations
-
-import click
-
-from jcli.cli_helpers import get_client, get_formatter
-from jcli.sdk.build import (
-    cancel_queue_item,
-    get_build,
-    get_build_artifacts,
-    get_build_log,
-    get_builds,
-    get_queue,
-    stop_build,
-    trigger_build,
-)
-from jcli.sdk.exceptions import JenkinsError
-
-
-def _parse_params(raw_params: tuple[str, ...]) -> dict[str, str]:
-    """Parse ``KEY=VAL`` strings into a dict."""
-    params: dict[str, str] = {}
-    for item in raw_params:
-        if "=" not in item:
-            raise click.BadParameter(f"Invalid parameter format: {item} (expected KEY=VAL)")
-        key, _, value = item.partition("=")
-        params[key.strip()] = value.strip()
-    return params
-
-
-# ------------------------------------------------------------------
-# Build group
-# ------------------------------------------------------------------
-
-
-@click.group("build", help="Manage Jenkins builds.")
-def build_group():
-    """Build management commands."""
-
-
-@build_group.command("trigger")
-@click.argument("job_name")
-@click.option(
-    "--params", "-p",
-    multiple=True,
-    help="Build parameters as KEY=VAL pairs. Repeatable.",
-)
-@click.pass_context
-def trigger(ctx: click.Context, job_name: str, params: tuple[str, ...]):
-    """Trigger a new build for JOB_NAME.
-
-    Use --params/-p KEY=VAL to pass build parameters (repeat for multiple).
-    """
-    client = get_client(ctx)
-    fmt = get_formatter(ctx)
-    try:
-        param_dict = _parse_params(params) if params else None
-        result = trigger_build(client, job_name, param_dict)
-        fmt.print_success(f"Build triggered for {job_name}")
-        fmt.print_json(result)
-    except JenkinsError as exc:
-        fmt.print_error(str(exc))
-        raise SystemExit(1)
-
-
-@build_group.command("list")
-@click.argument("job_name")
-@click.option("--limit", "-n", default=10, type=int, help="Maximum builds to show.")
-@click.pass_context
-def list_builds(ctx: click.Context, job_name: str, limit: int):
-    """List recent builds for JOB_NAME."""
-    client = get_client(ctx)
-    fmt = get_formatter(ctx)
-    try:
-        builds = get_builds(client, job_name, limit=limit)
-        if not builds:
-            fmt.print_info(f"No builds found for {job_name}")
-            return
-
-        headers = ["Number", "Result", "Timestamp", "Duration", "Building"]
-        rows = [
-            [
-                b.get("number", ""),
-                str(b.get("result") or "IN PROGRESS"),
-                str(b.get("timestamp", "")),
-                str(b.get("duration", "")),
-                str(b.get("building", False)),
-            ]
-            for b in builds
-        ]
-        fmt.print_table(headers, rows, title=f"Builds for {job_name}")
-    except JenkinsError as exc:
-        fmt.print_error(str(exc))
-        raise SystemExit(1)
-
-
-@build_group.command("get")
-@click.argument("job_name")
-@click.argument("number", type=int)
-@click.pass_context
-def get_build_cmd(ctx: click.Context, job_name: str, number: int):
-    """Show details for a specific build."""
-    client = get_client(ctx)
-    fmt = get_formatter(ctx)
-    try:
-        build = get_build(client, job_name, number)
-        fmt.print_json(build)
-    except JenkinsError as exc:
-        fmt.print_error(str(exc))
-        raise SystemExit(1)
-
-
-@build_group.command("log")
-@click.argument("job_name")
-@click.argument("number", type=int)
-@click.pass_context
-def log_cmd(ctx: click.Context, job_name: str, number: int):
-    """Show console log for a build."""
-    client = get_client(ctx)
-    fmt = get_formatter(ctx)
-    try:
-        log_text = get_build_log(client, job_name, number)
-        fmt.console.print(log_text)
-    except JenkinsError as exc:
-        fmt.print_error(str(exc))
-        raise SystemExit(1)
-
-
-@build_group.command("stop")
-@click.argument("job_name")
-@click.argument("number", type=int)
-@click.pass_context
-def stop_cmd(ctx: click.Context, job_name: str, number: int):
-    """Stop a running build."""
-    client = get_client(ctx)
-    fmt = get_formatter(ctx)
-    try:
-        stop_build(client, job_name, number)
-        fmt.print_success(f"Build {job_name}#{number} stopped")
-    except JenkinsError as exc:
-        fmt.print_error(str(exc))
-        raise SystemExit(1)
-
-
-@build_group.command("queue")
-@click.pass_context
-def queue_cmd(ctx: click.Context):
-    """Show the current Jenkins build queue."""
-    client = get_client(ctx)
-    fmt = get_formatter(ctx)
-    try:
-        items = get_queue(client)
-        if not items:
-            fmt.print_info("Build queue is empty")
-            return
-
-        headers = ["ID", "Task", "Why", "In Queue Since"]
-        rows = [
-            [
-                str(item.get("id", "")),
-                str(item.get("task", {}).get("name", "")),
-                str(item.get("why", "")),
-                str(item.get("inQueueSince", "")),
-            ]
-            for item in items
-        ]
-        fmt.print_table(headers, rows, title="Build Queue")
-    except JenkinsError as exc:
-        fmt.print_error(str(exc))
-        raise SystemExit(1)
-
-
-@build_group.command("artifacts")
-@click.argument("job_name")
-@click.argument("build_number")
-@click.pass_context
-def artifacts_cmd(ctx: click.Context, job_name: str, build_number: str):
-    """List artifacts for a build."""
-    client = get_client(ctx)
-    fmt = get_formatter(ctx)
-    try:
-        data = get_build_artifacts(client, job_name, build_number)
-        artifacts = data.get("artifacts", [])
-        if not artifacts:
-            fmt.print_info("No artifacts found.")
-            return
-        headers = ["File Name", "Relative Path"]
-        rows = [[a["fileName"], a["relativePath"]] for a in artifacts]
-        fmt.print_table(headers, rows, title=f"Artifacts: {job_name} #{build_number}")
-    except Exception as exc:
-        fmt.print_error(str(exc))
-
-
-def register(parent_group: click.Group):
-    """Register the build subgroup under the parent Click group."""
-    parent_group.add_command(build_group)