API index and search · Build metadata

Supporting declarations

packages/cli/src/index.ts. These declarations explain referenced types. Only package-page symbols are package exports.

Exact source

/**
 * Absolute path to a native Rindle toolchain binary for the current platform.
 *
 * Resolution order:
 *  1. The binary's explicit `*_BINARY_PATH` override.
 *  2. `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.
 *  3. 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;

/** Absolute path to the `rindle` CLI binary for the current platform. See {@link binaryPath}. */
export declare function rindleBinaryPath(): string;

/** Absolute path to the `rindled` daemon binary for the current platform. See {@link binaryPath}. */
export declare function rindledBinaryPath(): string;

/** 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;

/** Spawn the `rindle` CLI with `args`. See {@link spawnBinary}. */
export declare function spawnRindle(args?: string[], options?: SpawnOptions): ChildProcess;

/** 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;