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

jcli/specs/resources/build.yaml

@@ -0,0 +1,160 @@
+name: build
+description: Manage Jenkins builds
+methods:
+  list:
+    description: List recent builds for a job
+    http:
+      method: GET
+      path: "job/{{ job_name | replace('/', '/job/') }}/api/json"
+      query:
+        tree: "builds[number,url,result,timestamp,duration,building]{% if limit > 0 %}{0,{{ limit }}}{% endif %}"
+      body: ''
+    params:
+      path:
+        - name: job_name
+          type: string
+          argument: true
+      body:
+        - name: limit
+          type: int
+          default: 10
+          description: Maximum builds to show
+    output:
+      items_path: $.builds
+      fields:
+        - name: number
+          alias: Number
+        - name: result
+          alias: Result
+        - name: duration
+          alias: Duration
+        - name: building
+          alias: Building
+
+  get:
+    description: Show details for a specific build
+    http:
+      method: GET
+      path: "job/{{ job_name | replace('/', '/job/') }}/{{ number }}/api/json"
+    params:
+      path:
+        - name: job_name
+          type: string
+          argument: true
+        - name: number
+          type: int
+          argument: true
+
+  trigger:
+    description: Trigger a new build for a job (with optional KEY=VAL params)
+    type: plugin:jenkins_build_trigger
+    params:
+      body:
+        - name: job_name
+          type: string
+          argument: true
+        - name: params
+          type: string
+          multiple: true
+
+  log:
+    description: Show console log for a build (-f to follow live, -n for trailing lines)
+    type: plugin:jenkins_build_log
+    params:
+      body:
+        - name: job_name
+          type: string
+          argument: true
+        - name: number
+          type: int
+          argument: true
+        - name: follow
+          type: bool
+          description: Follow the log live (tail -f style)
+        - name: lines
+          type: int
+          description: "Number of trailing lines to show (default: all)"
+
+  stop:
+    description: Stop a running build
+    http:
+      method: POST
+      path: "job/{{ job_name | replace('/', '/job/') }}/{{ number }}/stop"
+    params:
+      path:
+        - name: job_name
+          type: string
+          argument: true
+        - name: number
+          type: int
+          argument: true
+
+  queue:
+    description: Show the current Jenkins build queue
+    http:
+      method: GET
+      path: queue/api/json
+    output:
+      items_path: $.items
+      fields:
+        - name: id
+          alias: ID
+        - name: why
+          alias: Why
+        - name: inQueueSince
+          alias: Since
+
+  artifacts:
+    description: List artifacts produced by a build
+    http:
+      method: GET
+      path: "job/{{ job_name | replace('/', '/job/') }}/{{ build_number }}/api/json"
+      query:
+        tree: "artifacts[fileName,relativePath]"
+    params:
+      path:
+        - name: job_name
+          type: string
+          argument: true
+        - name: build_number
+          type: int
+          argument: true
+    output:
+      items_path: $.artifacts
+      fields:
+        - name: fileName
+          alias: File
+        - name: relativePath
+          alias: Path
+
+  rebuild:
+    description: Rebuild a build reusing its parameters (with optional --set overrides)
+    type: plugin:jenkins_build_rebuild
+    params:
+      body:
+        - name: job_name
+          type: string
+          argument: true
+        - name: build_number
+          type: int
+          argument: true
+        - name: set
+          type: string
+          multiple: true
+          description: Override parameters (KEY=VAL)
+
+  replay:
+    description: Replay a Pipeline build with a modified Jenkinsfile
+    type: plugin:jenkins_build_replay
+    params:
+      body:
+        - name: job_name
+          type: string
+          argument: true
+        - name: build_number
+          type: int
+          argument: true
+        - name: jenkinsfile
+          type: file
+          argument: true
+          description: Jenkinsfile content to replay with

jcli/specs/resources/credential.yaml

@@ -0,0 +1,97 @@
+name: credential
+description: Manage Jenkins credentials
+methods:
+  list:
+    description: List credentials in a store/domain
+    http:
+      method: GET
+      path: "credentials/store/{{ store }}/domain/{{ domain }}/api/json"
+    params:
+      path:
+        - name: store
+          type: string
+          default: system
+        - name: domain
+          type: string
+          default: "_"
+      query:
+        - name: depth
+          type: int
+    output:
+      items_path: $.credentials
+      fields:
+        - name: id
+          alias: ID
+        - name: description
+          alias: Description
+        - name: typeName
+          alias: Type
+  get:
+    description: Get credential details
+    http:
+      method: GET
+      path: "credentials/store/{{ store }}/domain/_/credential/{{ cred_id }}/api/json"
+    params:
+      path:
+        - name: cred_id
+          type: string
+          argument: true
+        - name: store
+          type: string
+          default: system
+  create:
+    description: Create a credential from XML config
+    http:
+      method: POST
+      path: "credentials/store/{{ store }}/domain/{{ domain }}/createCredentials"
+      headers:
+        Content-Type: application/xml
+      body: "{{ xml_data }}"
+    params:
+      path:
+        - name: store
+          type: string
+          default: system
+        - name: domain
+          type: string
+          default: "_"
+      body:
+        - name: xml_data
+          type: file
+          argument: true
+  update:
+    description: Update an existing credential
+    http:
+      method: POST
+      path: "credentials/store/{{ store }}/domain/_/credential/{{ cred_id }}/updateCredentials"
+      headers:
+        Content-Type: application/xml
+      body: "{{ xml_data }}"
+    params:
+      path:
+        - name: cred_id
+          type: string
+          argument: true
+        - name: store
+          type: string
+          default: system
+      body:
+        - name: xml_data
+          type: file
+          argument: true
+  delete:
+    description: Delete a credential
+    http:
+      method: POST
+      path: "credentials/store/{{ store }}/domain/{{ domain }}/credential/{{ cred_id }}/doDelete"
+    params:
+      path:
+        - name: cred_id
+          type: string
+          argument: true
+        - name: store
+          type: string
+          default: system
+        - name: domain
+          type: string
+          default: "_"

jcli/specs/resources/job.yaml

@@ -0,0 +1,184 @@
+name: job
+description: Manage Jenkins jobs
+methods:
+  list:
+    description: List all Jenkins jobs
+    http:
+      method: GET
+      path: api/json
+      query:
+        tree: jobs[name,url,color]
+    output:
+      items_path: $.jobs
+      fields:
+        - name: name
+          alias: Name
+        - name: url
+          alias: URL
+        - name: color
+          alias: Color
+  get:
+    description: Show details for a specific job
+    http:
+      method: GET
+      path: job/{{ name }}/api/json
+    params:
+      path:
+        - name: name
+          type: string
+          argument: true
+    output:
+      items_path: $
+      fields:
+        - name: name
+          alias: Name
+        - name: description
+          alias: Description
+        - name: color
+          alias: Color
+        - name: buildable
+          alias: Buildable
+        - name: disabled
+          alias: Disabled
+  create:
+    description: Create a new job from XML config file or parameters
+    type: plugin:jenkins_job_create
+    params:
+      path:
+        - name: name
+          type: string
+          argument: true
+      body:
+        - name: config_file
+          type: file
+        - name: job_type
+          type: enum
+          choices: [freestyle, pipeline]
+        - name: git_url
+          type: string
+        - name: git_branch
+          type: string
+          default: main
+        - name: description
+          type: string
+        - name: shell
+          type: string
+        - name: cron
+          type: string
+        - name: jenkinsfile
+          type: string
+          default: Jenkinsfile
+        - name: script
+          type: string
+  update:
+    description: Update a job's configuration from an XML file
+    http:
+      method: POST
+      path: job/{{ 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 job
+    http:
+      method: POST
+      path: job/{{ name }}/doDelete
+    params:
+      path:
+        - name: name
+          type: string
+          argument: true
+  copy:
+    description: Copy a job to a new name
+    http:
+      method: POST
+      path: createItem
+      query:
+        name: '{{ new_name }}'
+        mode: copy
+        from: '{{ from_name }}'
+    params:
+      path:
+        - name: from_name
+          type: string
+          argument: true
+        - name: new_name
+          type: string
+          argument: true
+  rename:
+    description: Rename a job
+    http:
+      method: POST
+      path: job/{{ old_name }}/doRename
+      query:
+        newName: '{{ new_name }}'
+    params:
+      path:
+        - name: old_name
+          type: string
+          argument: true
+        - name: new_name
+          type: string
+          argument: true
+  enable:
+    description: Enable a disabled job
+    http:
+      method: POST
+      path: job/{{ name }}/enable
+    params:
+      path:
+        - name: name
+          type: string
+          argument: true
+  disable:
+    description: Disable a job
+    http:
+      method: POST
+      path: job/{{ name }}/disable
+    params:
+      path:
+        - name: name
+          type: string
+          argument: true
+  config:
+    description: Print the XML configuration of a job
+    http:
+      method: GET
+      path: job/{{ name }}/config.xml
+    params:
+      path:
+        - name: name
+          type: string
+          argument: true
+  create-folder:
+    description: Create a new folder
+    http:
+      method: POST
+      path: createItem
+      query:
+        name: '{{ name }}'
+        mode: com.cloudbees.hudson.plugins.folder.Folder
+    params:
+      path:
+        - name: name
+          type: string
+          argument: true
+  delete-folder:
+    description: Delete a folder and all its contents
+    http:
+      method: POST
+      path: job/{{ name }}/doDelete
+    params:
+      path:
+        - name: name
+          type: string
+          argument: true

jcli/specs/resources/node.yaml

@@ -0,0 +1,69 @@
+name: node
+description: Manage Jenkins nodes (agents)
+methods:
+  list:
+    description: List all Jenkins nodes
+    http:
+      method: GET
+      path: computer/api/json
+    output:
+      items_path: $.computer
+      fields:
+        - name: displayName
+          alias: Name
+        - name: offline
+          alias: Offline
+        - name: temporarilyOffline
+          alias: Temp Offline
+  get:
+    description: Get details of a specific node
+    http:
+      method: GET
+      path: "computer/{{ name }}/api/json"
+    params:
+      path:
+        - name: name
+          type: string
+          argument: true
+  delete:
+    description: Delete a Jenkins node
+    http:
+      method: POST
+      path: "computer/{{ name }}/doDelete"
+    params:
+      path:
+        - name: name
+          type: string
+          argument: true
+  toggle:
+    description: Toggle a node offline or online
+    http:
+      method: POST
+      path: "computer/{{ name }}/toggleOffline"
+    params:
+      path:
+        - name: name
+          type: string
+          argument: true
+      body:
+        - name: offlineMessage
+          type: string
+  create:
+    description: Create a new Jenkins agent node
+    type: plugin:jenkins_node_create
+    params:
+      body:
+        - name: name
+          type: string
+          argument: true
+        - name: num_executors
+          type: int
+          default: 1
+        - name: remote_fs
+          type: string
+          default: /tmp
+        - name: labels
+          type: string
+        - name: launch_method
+          type: string
+          default: hudson.slaves.JNLPLauncher

jcli/specs/resources/pipeline.yaml

@@ -0,0 +1,62 @@
+name: pipeline
+description: Manage Jenkins pipelines
+methods:
+  stages:
+    description: List stages for a Pipeline build
+    http:
+      method: GET
+      path: "job/{{ job_name | replace('/', '/job/') }}/{{ build_number }}/wfapi/describe"
+    params:
+      path:
+        - name: job_name
+          type: string
+          argument: true
+        - name: build_number
+          type: int
+          argument: true
+    output:
+      items_path: $.stages
+      fields:
+        - name: name
+          alias: Stage
+        - name: status
+          alias: Status
+        - name: durationMillis
+          alias: Duration
+  log:
+    description: Get log output for a Pipeline step
+    http:
+      method: GET
+      path: "job/{{ job_name | replace('/', '/job/') }}/{{ build_number }}/execution/node/{{ node_id }}/wfapi/log"
+    params:
+      path:
+        - name: job_name
+          type: string
+          argument: true
+        - name: build_number
+          type: int
+          argument: true
+        - name: node_id
+          type: string
+          argument: true
+  validate:
+    description: Validate a Jenkinsfile against the server
+    type: plugin:jenkins_pipeline_validate
+    params:
+      body:
+        - name: jenkinsfile
+          type: file
+          argument: true
+  pending:
+    description: Show pending input actions for a Pipeline build
+    http:
+      method: GET
+      path: "job/{{ job_name | replace('/', '/job/') }}/{{ build_number }}/wfapi/pendingInputActions"
+    params:
+      path:
+        - name: job_name
+          type: string
+          argument: true
+        - name: build_number
+          type: int
+          argument: true

jcli/specs/resources/plugin.yaml

@@ -0,0 +1,65 @@
+name: plugin
+description: Manage Jenkins plugins
+methods:
+  list:
+    description: List installed Jenkins plugins
+    http:
+      method: GET
+      path: pluginManager/api/json
+      query:
+        tree: "plugins[shortName,version,active,hasUpdate]"
+    output:
+      items_path: $.plugins
+      fields:
+        - name: shortName
+          alias: Name
+        - name: version
+          alias: Version
+        - name: active
+          alias: Active
+        - name: hasUpdate
+          alias: Update
+  get:
+    description: Show details for a single plugin
+    type: plugin:jenkins_plugin_get
+    params:
+      body:
+        - name: short_name
+          type: string
+          argument: true
+  install:
+    description: Install one or more plugins (NAME or NAME@VERSION)
+    type: plugin:jenkins_plugin_install
+    params:
+      body:
+        - name: plugins
+          type: string
+          multiple: true
+          argument: true
+  uninstall:
+    description: Uninstall a plugin
+    http:
+      method: POST
+      path: "pluginManager/plugin/{{ short_name }}/doUninstall"
+    params:
+      path:
+        - name: short_name
+          type: string
+          argument: true
+  check-updates:
+    description: Check for plugin updates
+    http:
+      method: POST
+      path: pluginManager/checkUpdates
+    output:
+      format: json
+  restart:
+    description: Restart a plugin
+    http:
+      method: POST
+      path: "pluginManager/plugin/{{ short_name }}/restart"
+    params:
+      path:
+        - name: short_name
+          type: string
+          argument: true

jcli/specs/resources/system.yaml

@@ -0,0 +1,72 @@
+name: system
+description: Jenkins system information and management
+methods:
+  info:
+    description: Show Jenkins system version and stats
+    type: plugin:jenkins_system_info
+    params:
+      body: {}
+
+  load:
+    description: Show queue length and executor usage
+    type: plugin:jenkins_system_load
+    params:
+      body: {}
+
+  quiet-down:
+    description: Put Jenkins into quiet-down mode
+    http:
+      method: POST
+      path: quietDown
+      query:
+        reason: '{{ reason }}'
+    params:
+      query:
+        - name: reason
+          type: string
+
+  cancel-quiet-down:
+    description: Cancel quiet-down mode
+    http:
+      method: POST
+      path: cancelQuietDown
+
+  restart:
+    description: Trigger a safe restart of Jenkins
+    http:
+      method: POST
+      path: safeRestart
+
+  script:
+    description: Execute a Groovy script on the server
+    type: plugin:jenkins_system_script
+    params:
+      body:
+        - name: script
+          type: string
+          argument: true
+
+  users:
+    description: List all Jenkins users
+    http:
+      method: GET
+      path: asynchPeople/api/json
+    output:
+      items_path: $.users
+      fields:
+        - name: id
+          alias: ID
+        - name: fullName
+          alias: Name
+
+  token:
+    description: Generate a new API token for a user
+    type: plugin:jenkins_system_token
+    params:
+      body:
+        - name: username
+          type: string
+          argument: true
+        - name: token_name
+          type: string
+          default: jcli-generated