diff --git a/.changeset/engine-binary-rushdb.md b/.changeset/engine-binary-rushdb.md new file mode 100644 index 0000000..0546ce4 --- /dev/null +++ b/.changeset/engine-binary-rushdb.md @@ -0,0 +1,5 @@ +--- +"@rushdb/javascript-sdk": patch +--- + +Refer to the self-hosted engine binary as `rushdb` (`rushdb serve`) in the README, JSDoc, and generated docs. diff --git a/README.md b/README.md index 549c90e..eaaea75 100755 --- a/README.md +++ b/README.md @@ -178,7 +178,7 @@ The SDK works with RushDB in one of two ways: | | RushDB Cloud | Self-hosted RushDB engine (direct mode) | | --- | --- | --- | -| What you run | nothing: the managed service at [app.rushdb.com](https://app.rushdb.com) | one `rushdbd` binary, on your own infrastructure | +| What you run | nothing: the managed service at [app.rushdb.com](https://app.rushdb.com) | one `rushdb` binary, on your own infrastructure | | Connect with | an API key | the engine URL and the engine token | The engine is what you can self-host. RushDB Cloud runs that engine for you and adds the dashboard, diff --git a/docs-reference.json b/docs-reference.json index 183604e..ffa661c 100755 --- a/docs-reference.json +++ b/docs-reference.json @@ -10709,7 +10709,7 @@ }, { "kind": "code", - "text": "`rushdbd`" + "text": "`rushdb`" }, { "kind": "text", @@ -23302,7 +23302,7 @@ }, { "kind": "code", - "text": "`rushdbd`" + "text": "`rushdb`" }, { "kind": "text", @@ -47236,7 +47236,7 @@ }, { "kind": "code", - "text": "`rushdbd`" + "text": "`rushdb`" }, { "kind": "text", @@ -47480,7 +47480,7 @@ }, { "kind": "code", - "text": "`rushdbd --multitenant`" + "text": "`rushdb serve --multitenant`" }, { "kind": "text", @@ -51315,7 +51315,7 @@ }, { "kind": "code", - "text": "`rushdbd`" + "text": "`rushdb`" }, { "kind": "text", diff --git a/docs-reference/classes/RestAPI.md b/docs-reference/classes/RestAPI.md index f698670..7f47b82 100644 --- a/docs-reference/classes/RestAPI.md +++ b/docs-reference/classes/RestAPI.md @@ -258,7 +258,7 @@ Optional smart-search context and transaction Defined in: [api/api.ts:85](https://github.com/rush-db/javascript-sdk/blob/main/src/api/api.ts#L85) -Direct engine transport (standalone `rushdbd`) when `direct` mode is set. +Direct engine transport (standalone `rushdb`) when `direct` mode is set. In direct mode every request is answered from the engine; nothing is sent to RushDB Cloud. diff --git a/docs-reference/classes/RushDB.md b/docs-reference/classes/RushDB.md index 980cc98..ee096ba 100644 --- a/docs-reference/classes/RushDB.md +++ b/docs-reference/classes/RushDB.md @@ -266,7 +266,7 @@ Optional smart-search context and transaction Defined in: [api/api.ts:85](https://github.com/rush-db/javascript-sdk/blob/main/src/api/api.ts#L85) -Direct engine transport (standalone `rushdbd`) when `direct` mode is set. +Direct engine transport (standalone `rushdb`) when `direct` mode is set. In direct mode every request is answered from the engine; nothing is sent to RushDB Cloud. diff --git a/docs-reference/type-aliases/SDKConfig.md b/docs-reference/type-aliases/SDKConfig.md index 13d6322..3319696 100644 --- a/docs-reference/type-aliases/SDKConfig.md +++ b/docs-reference/type-aliases/SDKConfig.md @@ -16,7 +16,7 @@ Defined in: [sdk/types.ts:27](https://github.com/rush-db/javascript-sdk/blob/mai > `optional` **direct?**: `boolean` -Direct mode: talk to a standalone RushDB engine (`rushdbd`) instead of +Direct mode: talk to a standalone RushDB engine (`rushdb`) instead of RushDB Cloud. Requires `engineUrl`; the token is the engine token. The methods listed in `CLOUD_ONLY_METHODS` throw `CloudOnlyError`, and no request is ever sent to RushDB Cloud. @@ -53,7 +53,7 @@ which results in deleting all Records in the project. > `optional` **scope?**: `string` -Tenant on a multitenant engine (`rushdbd --multitenant`), sent as +Tenant on a multitenant engine (`rushdb serve --multitenant`), sent as `X-RushDB-Tenant`. Omit for a single-tenant engine. ### timeout? diff --git a/docs-reference/variables/CLOUD_ONLY_METHODS.md b/docs-reference/variables/CLOUD_ONLY_METHODS.md index e393ae2..ee46cc0 100644 --- a/docs-reference/variables/CLOUD_ONLY_METHODS.md +++ b/docs-reference/variables/CLOUD_ONLY_METHODS.md @@ -14,7 +14,7 @@ What RushDB Cloud adds over a standalone engine, as SDK methods. One list: the direct-mode router refuses these with `CloudOnlyError`, the MCP server hides the tools built on them, and the docs mark them. -Everything else the SDK offers runs against a standalone `rushdbd` too. +Everything else the SDK offers runs against a standalone `rushdb` too. ## Type Declaration diff --git a/src/api/api.ts b/src/api/api.ts index 13c4abc..d96cb0b 100755 --- a/src/api/api.ts +++ b/src/api/api.ts @@ -78,7 +78,7 @@ export class RestAPI { public options: SDKConfig['options'] public logger: SDKConfig['logger'] /** - * Direct engine transport (standalone `rushdbd`) when `direct` mode is set. + * Direct engine transport (standalone `rushdb`) when `direct` mode is set. * In direct mode every request is answered from the engine; nothing is sent * to RushDB Cloud. */ diff --git a/src/direct/capabilities.ts b/src/direct/capabilities.ts index 437f971..8338f28 100644 --- a/src/direct/capabilities.ts +++ b/src/direct/capabilities.ts @@ -3,7 +3,7 @@ * the direct-mode router refuses these with `CloudOnlyError`, the MCP server * hides the tools built on them, and the docs mark them. * - * Everything else the SDK offers runs against a standalone `rushdbd` too. + * Everything else the SDK offers runs against a standalone `rushdb` too. */ export const CLOUD_ONLY_METHODS = { 'ai.search': 'natural-language search turns the prompt into a query with an LLM', diff --git a/src/direct/engine.ts b/src/direct/engine.ts index 41ae7dd..d04c08c 100755 --- a/src/direct/engine.ts +++ b/src/direct/engine.ts @@ -16,7 +16,7 @@ export type ProtocolResponse = { /** * Direct engine transport: executes protocol operations against a standalone - * `rushdbd` (`/protocol/v1/execute`) over HTTP. This is the SDK's "direct + * `rushdb` (`/protocol/v1/execute`) over HTTP. This is the SDK's "direct * mode" — no RushDB Cloud. `scope` is the tenant on a multitenant engine * (`X-RushDB-Tenant`); auth is the engine token. */ diff --git a/src/sdk/types.ts b/src/sdk/types.ts index a0ddb5e..24feb40 100755 --- a/src/sdk/types.ts +++ b/src/sdk/types.ts @@ -29,7 +29,7 @@ export type SDKConfig = { timeout?: number logger?: Logger /** - * Direct mode: talk to a standalone RushDB engine (`rushdbd`) instead of + * Direct mode: talk to a standalone RushDB engine (`rushdb`) instead of * RushDB Cloud. Requires `engineUrl`; the token is the engine token. The * methods listed in `CLOUD_ONLY_METHODS` throw `CloudOnlyError`, and no * request is ever sent to RushDB Cloud. @@ -38,7 +38,7 @@ export type SDKConfig = { /** Standalone engine base URL when `direct` is enabled (e.g. `http://127.0.0.1:3000`). */ engineUrl?: string /** - * Tenant on a multitenant engine (`rushdbd --multitenant`), sent as + * Tenant on a multitenant engine (`rushdb serve --multitenant`), sent as * `X-RushDB-Tenant`. Omit for a single-tenant engine. */ scope?: string diff --git a/test/direct-engine.live.spec.ts b/test/direct-engine.live.spec.ts index e6a3a98..208bbc3 100644 --- a/test/direct-engine.live.spec.ts +++ b/test/direct-engine.live.spec.ts @@ -1,10 +1,10 @@ /** * Direct mode against a real standalone engine. Runs only when * `RUSHDB_TEST_ENGINE_URL` (and `RUSHDB_TEST_ENGINE_TOKEN`, default - * `local-token`) point at a single-tenant `rushdbd` started with + * `local-token`) point at a single-tenant `rushdb` started with * `--languages cypher`, e.g. * - * rushdbd --data-dir /tmp/rushdb-test --port 3877 --languages cypher + * rushdb serve --data-dir /tmp/rushdb-test --port 3877 --languages cypher * RUSHDB_TEST_ENGINE_URL=http://127.0.0.1:3877 pnpm test */ import { describe, it, expect, beforeAll } from 'vitest'