Skip to content

JavaScript SDK README: Quick Start hardcodes play.orkes.io, no OSS path shown #24

@nthmost-orkes

Description

@nthmost-orkes

Problem

The JavaScript SDK README Quick Start example hardcodes Orkes Cloud as the server:

```typescript
const client = await orkesConductorClient({
serverUrl: "https://play.orkes.io/api",
keyId: "your-key-id",
keySecret: "your-key-secret"
});
```

There is no example showing how to connect to a local OSS server without authentication. An OSS user has to figure out on their own that keyId/keySecret are optional and that serverUrl should be http://localhost:8080/api.

Additionally, the client factory function is called orkesConductorClient — a name that signals "enterprise" to an OSS user before they've even written a line of code.

Fix

Add an OSS-first example at the top of Quick Start:

```typescript
// OSS (no auth required)
const client = await orkesConductorClient({
serverUrl: "http://localhost:8080/api"
});
```

Then show the Orkes Cloud variant as an alternative.

Affects

  • conductor-oss/javascript-sdk README

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions