⚠️ DEPRECATION NOTICE

This repository is deprecated and is no longer actively maintained. We recommend migrating to the official Rundeck API client or using the Rundeck REST API directly.

• No new features will be added
• No bug fixes will be provided
• No security updates will be released

Please consider alternative solutions for your Rundeck integration needs.

---

Rundeck TypeScript(Javascript) SDK

TypeScript SDK generated from an OpenApi 2.0 spec via Autorest.

WARNING: The OpenApi spec and SDK are under heavy development. The spec, methods, interfaces, and project structure may change heavily between releases.

Example Usage

import {Rundeck, PasswordCredentialProvider} from 'ts-rundeck'

async function main() {
    const credProvider = new PasswordCredentialProvider('admin', 'admin')
    const rundeck = new Rundeck(credProvider, 'http://127.0.0.1:4440', {withCredentials: true})

    const users = await rundeck.userList()
}

main()

Building

Pre-requisites

DotNet Core SDK - Required for the Autorest backend
Nodejs/npm - Required for the Autorest frontend

Quick Start

To generate client and compile TypeScript to /dist:

npm run build

Slow Start

Checkout the Autorest literate configuration here.