@runreal/sdk-ts

runreal-sdk-ts

Developer-friendly & type-safe Typescript SDK specifically catered to leverage runreal-sdk-ts API.

[!IMPORTANT] This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your workspace. Delete this section before > publishing to a package manager.

Summary

Runreal API: Runreal API enables API commands to interact with the Runreal platform.

Table of Contents

• runreal-sdk-ts
  • SDK Installation
  • Requirements
  • SDK Example Usage
  • Authentication
  • Available Resources and Operations
  • Standalone functions
  • Retries
  • Error Handling
  • Server Selection
  • Custom HTTP Client
  • Debugging
• Development
  • Maturity
  • Contributions

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add @runreal/sdk-ts

PNPM

pnpm add @runreal/sdk-ts

Bun

bun add @runreal/sdk-ts

Yarn

yarn add @runreal/sdk-ts zod

# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.

[!NOTE] This package is published with CommonJS and ES Modules (ESM) support.

Model Context Protocol (MCP) Server

This SDK is also an installable MCP server where the various SDK methods are exposed as tools that can be invoked by AI applications.

Node.js v20 or greater is required to run the MCP server from npm.

Claude installation steps

Add the following server definition to your claude_desktop_config.json file:

{
  "mcpServers": {
    "RunrealSDK": {
      "command": "npx",
      "args": [
        "-y", "--package", "@runreal/sdk-ts",
        "--",
        "mcp", "start",
        "--api-key-auth", "..."
      ]
    }
  }
}

Cursor installation steps

Create a .cursor/mcp.json file in your project root with the following content:

{
  "mcpServers": {
    "RunrealSDK": {
      "command": "npx",
      "args": [
        "-y", "--package", "@runreal/sdk-ts",
        "--",
        "mcp", "start",
        "--api-key-auth", "..."
      ]
    }
  }
}

You can also run MCP servers as a standalone binary with no additional dependencies. You must pull these binaries from available Github releases:

curl -L -o mcp-server \
    https://github.com/{org}/{repo}/releases/download/{tag}/mcp-server-bun-darwin-arm64 && \
chmod +x mcp-server

If the repo is a private repo you must add your Github PAT to download a release -H "Authorization: Bearer {GITHUB_PAT}".

{
  "mcpServers": {
    "Todos": {
      "command": "./DOWNLOAD/PATH/mcp-server",
      "args": [
        "start"
      ]
    }
  }
}

For a full list of server arguments, run:

npx -y --package @runreal/sdk-ts -- mcp start --help

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { RunrealSDK } from "@runreal/sdk-ts";

const runrealSDK = new RunrealSDK();

async function run() {
  const result = await runrealSDK.cli.postCli();

  // Handle the result
  console.log(result);
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme	Environment Variable
apiKeyAuth	apiKey	API key	RUNREALSDK_API_KEY_AUTH

To authenticate with the API the apiKeyAuth parameter must be set when initializing the SDK client instance. For example:

import { RunrealSDK } from "@runreal/sdk-ts";

const runrealSDK = new RunrealSDK({
  apiKeyAuth: process.env["RUNREALSDK_API_KEY_AUTH"] ?? "",
});

async function run() {
  const result = await runrealSDK.cli.postCli();

  // Handle the result
  console.log(result);
}

run();

Available Resources and Operations

Available methods

artifacts

• getArtifactsIdDownload
• getArtifactsId - Return a specific artifact
• getArtifacts - Return all artifacts
• getArtifactsIdMetadata

builds

• getBuildsBuildId - Get a build by ID
• postBuilds - Create a new build

cli

• postCli

repositories

• getRepositoriesId - Get a repository by id
• deleteRepositoriesId - Delete a repository by id
• getRepositories - Get all repositories

workflows

• postWorkflows - Create a new workflow
• putWorkflowsId - Update a workflow
• getWorkflowsId - Get a workflow
• postWorkflowsIdLogs - Ingest a new log

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

Available standalone functions

• artifactsGetArtifacts - Return all artifacts
• artifactsGetArtifactsId - Return a specific artifact
• artifactsGetArtifactsIdDownload
• artifactsGetArtifactsIdMetadata
• buildsGetBuildsBuildId - Get a build by ID
• buildsPostBuilds - Create a new build
• cliPostCLI
• repositoriesDeleteRepositoriesId - Delete a repository by id
• repositoriesGetRepositories - Get all repositories
• repositoriesGetRepositoriesId - Get a repository by id
• workflowsGetWorkflowsId - Get a workflow
• workflowsPostWorkflows - Create a new workflow
• workflowsPostWorkflowsIdLogs - Ingest a new log
• workflowsPutWorkflowsId - Update a workflow

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { RunrealSDK } from "@runreal/sdk-ts";

const runrealSDK = new RunrealSDK();

async function run() {
  const result = await runrealSDK.cli.postCli({
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  // Handle the result
  console.log(result);
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { RunrealSDK } from "@runreal/sdk-ts";

const runrealSDK = new RunrealSDK({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
});

async function run() {
  const result = await runrealSDK.cli.postCli();

  // Handle the result
  console.log(result);
}

run();

Error Handling

Some methods specify known errors which can be thrown. All the known errors are enumerated in the models/errors/errors.ts module. The known errors for a method are documented under the Errors tables in SDK docs. For example, the postCli method may throw the following errors:

Error Type	Status Code	Content Type
errors.PostCliBadRequestError	400	application/json
errors.PostCliUnauthorizedError	401	application/json
errors.PostCliNotFoundError	404	application/json
errors.APIError	4XX, 5XX	*/*

If the method throws an error and it is not captured by the known errors, it will default to throwing a APIError.

import { RunrealSDK } from "@runreal/sdk-ts";
import {
  PostCliBadRequestError,
  PostCliNotFoundError,
  PostCliUnauthorizedError,
  SDKValidationError,
} from "@runreal/sdk-ts/models/errors";

const runrealSDK = new RunrealSDK();

async function run() {
  let result;
  try {
    result = await runrealSDK.cli.postCli();

    // Handle the result
    console.log(result);
  } catch (err) {
    switch (true) {
      // The server response does not match the expected SDK schema
      case (err instanceof SDKValidationError): {
        // Pretty-print will provide a human-readable multi-line error message
        console.error(err.pretty());
        // Raw value may also be inspected
        console.error(err.rawValue);
        return;
      }
      case (err instanceof PostCliBadRequestError): {
        // Handle err.data$: PostCliBadRequestErrorData
        console.error(err);
        return;
      }
      case (err instanceof PostCliUnauthorizedError): {
        // Handle err.data$: PostCliUnauthorizedErrorData
        console.error(err);
        return;
      }
      case (err instanceof PostCliNotFoundError): {
        // Handle err.data$: PostCliNotFoundErrorData
        console.error(err);
        return;
      }
      default: {
        // Other errors such as network errors, see HTTPClientErrors for more details
        throw err;
      }
    }
  }
}

run();

Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The SDKValidationError that is thrown as a result will capture the raw value that failed validation in an attribute called rawValue. Additionally, a pretty() method is available on this error that can be used to log a nicely formatted multi-line string since validation errors can list many issues and the plain error string may be difficult read when debugging.

In some rare cases, the SDK can fail to get a response from the server or even make the request due to unexpected circumstances such as network conditions. These types of errors are captured in the models/errors/httpclienterrors.ts module:

HTTP Client Error	Description
RequestAbortedError	HTTP request was aborted by the client
RequestTimeoutError	HTTP request timed out due to an AbortSignal signal
ConnectionError	HTTP client was unable to make a request to a server
InvalidRequestError	Any input used to create a request is invalid
UnexpectedClientError	Unrecognised or unexpected error

Server Selection

Override Server URL Per-Client

The default server can be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:

import { RunrealSDK } from "@runreal/sdk-ts";

const runrealSDK = new RunrealSDK({
  serverURL: "https://api.dashboard.runreal.dev/v1",
});

async function run() {
  const result = await runrealSDK.cli.postCli();

  // Handle the result
  console.log(result);
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to use the "beforeRequest" hook to to add a custom header and a timeout to requests and how to use the "requestError" hook to log errors:

import { RunrealSDK } from "@runreal/sdk-ts";
import { HTTPClient } from "@runreal/sdk-ts/lib/http";

const httpClient = new HTTPClient({
  // fetcher takes a function that has the same signature as native `fetch`.
  fetcher: (request) => {
    return fetch(request);
  }
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new RunrealSDK({ httpClient });

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { RunrealSDK } from "@runreal/sdk-ts";

const sdk = new RunrealSDK({ debugLogger: console });

You can also enable a default debug logger by setting an environment variable RUNREALSDK_DEBUG to true.

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy