@rindle/cli

0.0.0 · Public export map; development manifest version (0.0.0).

Source revision 05d0bf2c2e56 · build details

Source revision: 05d0bf2c2e56.
TypeScript input SHA-256: aabe6cfcc4172b870d5e272142958e9ea8d8784c2aa23133156e5a7ee633318e
Generated 2026-09-04T23:58:25.590Z with TypeScript 6.0.3. Public TypeScript checks and declaration emit passed. Package runtime tests are separate.

Entry point source

Binary

TypeAliasDeclaration · Source: packages/cli/src/platform.ts:15 · Supporting declarations

A native binary shipped by the Rindle development toolchain.

export type Binary = "rindle" | "rindled" | "rindle-replicator" | "rindle-dev-edge";

binaryName

FunctionDeclaration · Source: packages/cli/src/platform.ts:48 · Supporting declarations

The on-disk filename of bin inside a platform package (rindle / rindled.exe).

export declare function binaryName(bin: Binary, platform?: NodeJS.Platform): string;

binaryPath

FunctionDeclaration · Source: packages/cli/src/index.ts:49 · Supporting declarations

Absolute path to a native Rindle toolchain binary for the current platform.

Resolution order:

The binary's explicit *_BINARY_PATH override.
RINDLE_BIN_DIR — a directory holding the co-located toolchain. Point it at target/release after building the four binary crates and one env var lights up the fleet.
The matching @rindle/cli-<key> optional dependency that npm/pnpm installed.

Throws UnsupportedPlatformError for an un-targeted host, or a descriptive Error if the platform package isn't installed (e.g. installed with --no-optional, or on a host the last publish didn't target) and no override is set.

export declare function binaryPath(bin: Binary): string;

Libc

TypeAliasDeclaration · Source: packages/cli/src/platform.ts:12 · Supporting declarations

export type Libc = "gnu" | "musl";

platformKey

FunctionDeclaration · Source: packages/cli/src/platform.ts:22 · Supporting declarations

The package-name suffix identifying a build target for the current (or given) host: darwin-{arm64,x64}, linux-{x64,arm64}-{gnu,musl}, win32-x64-msvc. Throws UnsupportedPlatformError for a host we don't publish binaries for.

export declare function platformKey(platform?: NodeJS.Platform, arch?: string, libc?: Libc): string;

platformPackageName

FunctionDeclaration · Source: packages/cli/src/platform.ts:43 · Supporting declarations

The npm package name carrying the binaries for key (default: the current host's key).

export declare function platformPackageName(key?: string): string;

rindleBinaryPath

FunctionDeclaration · Source: packages/cli/src/index.ts:88 · Supporting declarations

Absolute path to the rindle CLI binary for the current platform. See {@link binaryPath}.

export declare function rindleBinaryPath(): string;

rindledBinaryPath

FunctionDeclaration · Source: packages/cli/src/index.ts:93 · Supporting declarations

Absolute path to the rindled daemon binary for the current platform. See {@link binaryPath}.

export declare function rindledBinaryPath(): string;

spawnBinary

FunctionDeclaration · Source: packages/cli/src/index.ts:98 · Supporting declarations

Spawn bin with args, inheriting stdio by default. A thin wrapper over child_process.spawn.

export declare function spawnBinary(bin: Binary, args?: string[], options?: SpawnOptions): ChildProcess;

spawnRindle

FunctionDeclaration · Source: packages/cli/src/index.ts:103 · Supporting declarations

Spawn the rindle CLI with args. See {@link spawnBinary}.

export declare function spawnRindle(args?: string[], options?: SpawnOptions): ChildProcess;

spawnRindled

FunctionDeclaration · Source: packages/cli/src/index.ts:108 · Supporting declarations

Spawn the rindled daemon with args, for embedding it in a Node supervisor. See {@link spawnBinary}.

export declare function spawnRindled(args?: string[], options?: SpawnOptions): ChildProcess;

UnsupportedPlatformError

ClassDeclaration · Source: packages/cli/src/platform.ts:52 · Supporting declarations

export declare class UnsupportedPlatformError extends Error {
    constructor(platform: string, arch: string);
}