@effect/platform 0.1.0 → 0.2.0

package/mjs/internal/commandExecutor.mjs

@@ -0,0 +1,42 @@
+import * as Brand from "@effect/data/Brand";
+import * as Chunk from "@effect/data/Chunk";
+import { Tag } from "@effect/data/Context";
+import * as Effect from "@effect/io/Effect";
+import * as Sink from "@effect/stream/Sink";
+import * as Stream from "@effect/stream/Stream";
+/** @internal */
+export const ProcessTypeId = /*#__PURE__*/Symbol.for("@effect/platform/Process");
+/** @internal */
+export const ExitCode = /*#__PURE__*/Brand.nominal();
+/** @internal */
+export const ProcessId = /*#__PURE__*/Brand.nominal();
+/** @internal */
+export const CommandExecutor = /*#__PURE__*/Tag();
+/** @internal */
+export const makeExecutor = start => {
+  const stream = command => Stream.flatMap(process => process.stdout)(Stream.fromEffect(start(command)));
+  const streamLines = (command, encoding) => {
+    const decoder = new TextDecoder(encoding);
+    return Stream.splitLines(Stream.mapChunks(stream(command), Chunk.map(bytes => decoder.decode(bytes))));
+  };
+  return {
+    start,
+    exitCode: command => Effect.flatMap(start(command), process => process.exitCode),
+    stream,
+    string: (command, encoding = "utf-8") => {
+      const decoder = new TextDecoder(encoding);
+      return Effect.map(bytes => decoder.decode(bytes))(Effect.flatMap(process => Stream.run(process.stdout, collectUint8Array))(start(command)));
+    },
+    lines: (command, encoding = "utf-8") => {
+      return Effect.map(Chunk.toReadonlyArray)(Stream.runCollect(streamLines(command, encoding)));
+    },
+    streamLines
+  };
+};
+const collectUint8Array = /*#__PURE__*/Sink.foldLeftChunks( /*#__PURE__*/new Uint8Array(), (bytes, chunk) => Chunk.reduce(chunk, bytes, (acc, curr) => {
+  const newArray = new Uint8Array(acc.length + curr.length);
+  newArray.set(acc);
+  newArray.set(curr, acc.length);
+  return newArray;
+}));
+//# sourceMappingURL=commandExecutor.mjs.map

package/mjs/internal/commandExecutor.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"commandExecutor.mjs","names":["Brand","Chunk","Tag","Effect","Sink","Stream","ProcessTypeId","Symbol","for","ExitCode","nominal","ProcessId","CommandExecutor","makeExecutor","start","stream","command","flatMap","process","stdout","fromEffect","streamLines","encoding","decoder","TextDecoder","splitLines","mapChunks","map","bytes","decode","exitCode","string","run","collectUint8Array","lines","toReadonlyArray","runCollect","foldLeftChunks","Uint8Array","chunk","reduce","acc","curr","newArray","length","set"],"sources":["../../src/internal/commandExecutor.ts"],"sourcesContent":[null],"mappings":"AAAA,OAAO,KAAKA,KAAK,MAAM,oBAAoB;AAC3C,OAAO,KAAKC,KAAK,MAAM,oBAAoB;AAC3C,SAASC,GAAG,QAAQ,sBAAsB;AAE1C,OAAO,KAAKC,MAAM,MAAM,mBAAmB;AAE3C,OAAO,KAAKC,IAAI,MAAM,qBAAqB;AAC3C,OAAO,KAAKC,MAAM,MAAM,uBAAuB;AAE/C;AACA,OAAO,MAAMC,aAAa,gBAAmCC,MAAM,CAACC,GAAG,CACrE,0BAA0B,CACO;AAEnC;AACA,OAAO,MAAMC,QAAQ,gBAAGT,KAAK,CAACU,OAAO,EAA6B;AAElE;AACA,OAAO,MAAMC,SAAS,gBAAGX,KAAK,CAACU,OAAO,EAA+B;AAErE;AACA,OAAO,MAAME,eAAe,gBAAGV,GAAG,EAAoC;AAEtE;AACA,OAAO,MAAMW,YAAY,GAAIC,KAAgD,IAAsC;EACjH,MAAMC,MAAM,GAAgDC,OAAO,IAG/DX,MAAM,CAACY,OAAO,CAAEC,OAAO,IAAKA,OAAO,CAACC,MAAM,CAAC,CAD3Cd,MAAM,CAACe,UAAU,CAACN,KAAK,CAACE,OAAO,CAAC,CAAC,CAElC;EACH,MAAMK,WAAW,GAAoDA,CAACL,OAAO,EAAEM,QAAQ,KAAI;IACzF,MAAMC,OAAO,GAAG,IAAIC,WAAW,CAACF,QAAQ,CAAC;IACzC,OAAOjB,MAAM,CAACoB,UAAU,CACtBpB,MAAM,CAACqB,SAAS,CAACX,MAAM,CAACC,OAAO,CAAC,EAAEf,KAAK,CAAC0B,GAAG,CAAEC,KAAK,IAAKL,OAAO,CAACM,MAAM,CAACD,KAAK,CAAC,CAAC,CAAC,CAC/E;EACH,CAAC;EACD,OAAO;IACLd,KAAK;IACLgB,QAAQ,EAAGd,OAAO,IAAKb,MAAM,CAACc,OAAO,CAACH,KAAK,CAACE,OAAO,CAAC,EAAGE,OAAO,IAAKA,OAAO,CAACY,QAAQ,CAAC;IACpFf,MAAM;IACNgB,MAAM,EAAEA,CAACf,OAAO,EAAEM,QAAQ,GAAG,OAAO,KAAI;MACtC,MAAMC,OAAO,GAAG,IAAIC,WAAW,CAACF,QAAQ,CAAC;MACzC,OAGEnB,MAAM,CAACwB,GAAG,CAAEC,KAAK,IAAKL,OAAO,CAACM,MAAM,CAACD,KAAK,CAAC,CAAC,CAD5CzB,MAAM,CAACc,OAAO,CAAEC,OAAO,IAAKb,MAAM,CAAC2B,GAAG,CAACd,OAAO,CAACC,MAAM,EAAEc,iBAAiB,CAAC,CAAC,CAD1EnB,KAAK,CAACE,OAAO,CAAC;IAIlB,CAAC;IACDkB,KAAK,EAAEA,CAAClB,OAAO,EAAEM,QAAQ,GAAG,OAAO,KAAI;MACrC,OAGEnB,MAAM,CAACwB,GAAG,CAAC1B,KAAK,CAACkC,eAAe,CAAC,CADjC9B,MAAM,CAAC+B,UAAU,CADjBf,WAAW,CAACL,OAAO,EAAEM,QAAQ,CAAC;IAIlC,CAAC;IACDD;GACD;AACH,CAAC;AAED,MAAMY,iBAAiB,gBAA2D7B,IAAI,CAACiC,cAAc,eACnG,IAAIC,UAAU,EAAE,EAChB,CAACV,KAAK,EAAEW,KAA8B,KACpCtC,KAAK,CAACuC,MAAM,CAACD,KAAK,EAAEX,KAAK,EAAE,CAACa,GAAG,EAAEC,IAAI,KAAI;EACvC,MAAMC,QAAQ,GAAG,IAAIL,UAAU,CAACG,GAAG,CAACG,MAAM,GAAGF,IAAI,CAACE,MAAM,CAAC;EACzDD,QAAQ,CAACE,GAAG,CAACJ,GAAG,CAAC;EACjBE,QAAQ,CAACE,GAAG,CAACH,IAAI,EAAED,GAAG,CAACG,MAAM,CAAC;EAC9B,OAAOD,QAAQ;AACjB,CAAC,CAAC,CACL"}

package/mjs/internal/fileSystem.mjs

@@ -28,7 +28,7 @@ const stream = (file, {
   offset = Size(0)
 } = {}) => Stream.bufferChunks(Stream.unfoldEffect(offset, position => {
   if (bytesToRead !== undefined && bytesToRead <= position - offset) {
-    return Effect.succeedNone();
+    return Effect.succeed(Option.none());
   }
   const toRead = bytesToRead !== undefined && bytesToRead - (position - offset) < chunkSize ? bytesToRead - (position - offset) : chunkSize;
   return Effect.map(Option.map(buf => [buf, Size(position + BigInt(buf.length))]))(file.readAlloc(toRead, {

package/mjs/internal/fileSystem.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"fileSystem.mjs","names":["Tag","Option","Effect","Sink","Stream","tag","Size","bytes","BigInt","make","impl","of","stream","path","options","unwrapScoped","map","file","open","flag","sink","forEach","_","writeAll","bufferSize","bytesToRead","chunkSize","offset","bufferChunks","unfoldEffect","position","undefined","succeedNone","toRead","buf","length","readAlloc"],"sources":["../../src/internal/fileSystem.ts"],"sourcesContent":[null],"mappings":"AAAA,SAASA,GAAG,QAAQ,sBAAsB;AAE1C,OAAO,KAAKC,MAAM,MAAM,qBAAqB;AAC7C,OAAO,KAAKC,MAAM,MAAM,mBAAmB;AAE3C,OAAO,KAAKC,IAAI,MAAM,qBAAqB;AAC3C,OAAO,KAAKC,MAAM,MAAM,uBAAuB;AAE/C;AACA,OAAO,MAAMC,GAAG,gBAAGL,GAAG,EAAc;AAEpC;AACA,OAAO,MAAMM,IAAI,GAAIC,KAAsB,IAAK,OAAOA,KAAK,KAAK,QAAQ,GAAGA,KAAc,GAAGC,MAAM,CAACD,KAAK,CAAU;AAEnH;AACA,OAAO,MAAME,IAAI,GAAIC,IAAyC,IAAgB;EAC5E,OAAOL,GAAG,CAACM,EAAE,CAAC;IACZ,GAAGD,IAAI;IACPE,MAAM,EAAEA,CAACC,IAAI,EAAEC,OAAO,KAIlBV,MAAM,CAACW,YAAY,CADnBb,MAAM,CAACc,GAAG,CAAEC,IAAI,IAAKL,MAAM,CAACK,IAAI,EAAEH,OAAO,CAAC,CAAC,CAD3CJ,IAAI,CAACQ,IAAI,CAACL,IAAI,EAAE;MAAEM,IAAI,EAAE;IAAG,CAAE,CAAC,EAG/B;IACHC,IAAI,EAAEA,CAACP,IAAI,EAAEC,OAAO,KAIhBX,IAAI,CAACY,YAAY,CADjBb,MAAM,CAACc,GAAG,CAAEC,IAAI,IAAKd,IAAI,CAACkB,OAAO,CAAEC,CAAa,IAAKL,IAAI,CAACM,QAAQ,CAACD,CAAC,CAAC,CAAC,CAAC,CADvEZ,IAAI,CAACQ,IAAI,CAACL,IAAI,EAAE;MAAEM,IAAI,EAAE,GAAG;MAAE,GAAGL;IAAO,CAAE,CAAC;GAI/C,CAAC;AACJ,CAAC;AAED;AACA,MAAMF,MAAM,GAAGA,CAACK,IAAU,EAAE;EAC1BO,UAAU,GAAG,CAAC;EACdC,WAAW;EACXC,SAAS,GAAGpB,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC;EAC3BqB,MAAM,GAAGrB,IAAI,CAAC,CAAC;AAAC,IACC,EAAE,KACnBF,MAAM,CAACwB,YAAY,CACjBxB,MAAM,CAACyB,YAAY,CAACF,MAAM,EAAGG,QAAQ,IAAI;EACvC,IAAIL,WAAW,KAAKM,SAAS,IAAIN,WAAW,IAAIK,QAAQ,GAAGH,MAAM,EAAE;IACjE,OAAOzB,MAAM,CAAC8B,WAAW,EAAE;;EAG7B,MAAMC,MAAM,GAAGR,WAAW,KAAKM,SAAS,IAAIN,WAAW,IAAIK,QAAQ,GAAGH,MAAM,CAAC,GAAGD,SAAS,GACrFD,WAAW,IAAIK,QAAQ,GAAGH,MAAM,CAAC,GACjCD,SAAS;EAEb,OAEExB,MAAM,CAACc,GAAG,CACRf,MAAM,CAACe,GAAG,CAAEkB,GAAG,IAAK,CAACA,GAAG,EAAE5B,IAAI,CAACwB,QAAQ,GAAGtB,MAAM,CAAC0B,GAAG,CAACC,MAAM,CAAC,CAAC,CAAU,CAAC,CACzE,CAHDlB,IAAI,CAACmB,SAAS,CAACH,MAAe,EAAE;IAAEN,MAAM,EAAEG;EAAQ,CAAE,CAAC;AAKzD,CAAC,CAAC,EACFN,UAAU,CACX"}
+{"version":3,"file":"fileSystem.mjs","names":["Tag","Option","Effect","Sink","Stream","tag","Size","bytes","BigInt","make","impl","of","stream","path","options","unwrapScoped","map","file","open","flag","sink","forEach","_","writeAll","bufferSize","bytesToRead","chunkSize","offset","bufferChunks","unfoldEffect","position","undefined","succeed","none","toRead","buf","length","readAlloc"],"sources":["../../src/internal/fileSystem.ts"],"sourcesContent":[null],"mappings":"AAAA,SAASA,GAAG,QAAQ,sBAAsB;AAE1C,OAAO,KAAKC,MAAM,MAAM,qBAAqB;AAC7C,OAAO,KAAKC,MAAM,MAAM,mBAAmB;AAE3C,OAAO,KAAKC,IAAI,MAAM,qBAAqB;AAC3C,OAAO,KAAKC,MAAM,MAAM,uBAAuB;AAE/C;AACA,OAAO,MAAMC,GAAG,gBAAGL,GAAG,EAAc;AAEpC;AACA,OAAO,MAAMM,IAAI,GAAIC,KAAsB,IAAK,OAAOA,KAAK,KAAK,QAAQ,GAAGA,KAAc,GAAGC,MAAM,CAACD,KAAK,CAAU;AAEnH;AACA,OAAO,MAAME,IAAI,GAAIC,IAAyC,IAAgB;EAC5E,OAAOL,GAAG,CAACM,EAAE,CAAC;IACZ,GAAGD,IAAI;IACPE,MAAM,EAAEA,CAACC,IAAI,EAAEC,OAAO,KAIlBV,MAAM,CAACW,YAAY,CADnBb,MAAM,CAACc,GAAG,CAAEC,IAAI,IAAKL,MAAM,CAACK,IAAI,EAAEH,OAAO,CAAC,CAAC,CAD3CJ,IAAI,CAACQ,IAAI,CAACL,IAAI,EAAE;MAAEM,IAAI,EAAE;IAAG,CAAE,CAAC,EAG/B;IACHC,IAAI,EAAEA,CAACP,IAAI,EAAEC,OAAO,KAIhBX,IAAI,CAACY,YAAY,CADjBb,MAAM,CAACc,GAAG,CAAEC,IAAI,IAAKd,IAAI,CAACkB,OAAO,CAAEC,CAAa,IAAKL,IAAI,CAACM,QAAQ,CAACD,CAAC,CAAC,CAAC,CAAC,CADvEZ,IAAI,CAACQ,IAAI,CAACL,IAAI,EAAE;MAAEM,IAAI,EAAE,GAAG;MAAE,GAAGL;IAAO,CAAE,CAAC;GAI/C,CAAC;AACJ,CAAC;AAED;AACA,MAAMF,MAAM,GAAGA,CAACK,IAAU,EAAE;EAC1BO,UAAU,GAAG,CAAC;EACdC,WAAW;EACXC,SAAS,GAAGpB,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC;EAC3BqB,MAAM,GAAGrB,IAAI,CAAC,CAAC;AAAC,IACC,EAAE,KACnBF,MAAM,CAACwB,YAAY,CACjBxB,MAAM,CAACyB,YAAY,CAACF,MAAM,EAAGG,QAAQ,IAAI;EACvC,IAAIL,WAAW,KAAKM,SAAS,IAAIN,WAAW,IAAIK,QAAQ,GAAGH,MAAM,EAAE;IACjE,OAAOzB,MAAM,CAAC8B,OAAO,CAAC/B,MAAM,CAACgC,IAAI,EAAE,CAAC;;EAGtC,MAAMC,MAAM,GAAGT,WAAW,KAAKM,SAAS,IAAIN,WAAW,IAAIK,QAAQ,GAAGH,MAAM,CAAC,GAAGD,SAAS,GACrFD,WAAW,IAAIK,QAAQ,GAAGH,MAAM,CAAC,GACjCD,SAAS;EAEb,OAEExB,MAAM,CAACc,GAAG,CACRf,MAAM,CAACe,GAAG,CAAEmB,GAAG,IAAK,CAACA,GAAG,EAAE7B,IAAI,CAACwB,QAAQ,GAAGtB,MAAM,CAAC2B,GAAG,CAACC,MAAM,CAAC,CAAC,CAAU,CAAC,CACzE,CAHDnB,IAAI,CAACoB,SAAS,CAACH,MAAe,EAAE;IAAEP,MAAM,EAAEG;EAAQ,CAAE,CAAC;AAKzD,CAAC,CAAC,EACFN,UAAU,CACX"}

package/package.json

@@ -1,15 +1,15 @@
 {
   "name": "@effect/platform",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "license": "MIT",
   "repository": {
     "type": "git",
     "url": "https://github.com/effect-ts/platform.git"
   },
   "dependencies": {
-    "@effect/data": "^0.12.8",
-    "@effect/io": "^0.26.1",
-    "@effect/stream": "^0.22.1",
+    "@effect/data": "^0.13.5",
+    "@effect/io": "^0.31.3",
+    "@effect/stream": "^0.25.1",
     "path-browserify": "^1.0.1"
   },
   "publishConfig": {

package/src/Command.ts

@@ -0,0 +1,278 @@
+/**
+ * @since 1.0.0
+ */
+import type { HashMap } from "@effect/data/HashMap"
+import type { Option } from "@effect/data/Option"
+import type { NonEmptyReadonlyArray } from "@effect/data/ReadonlyArray"
+import type { Effect } from "@effect/io/Effect"
+import type { CommandExecutor, ExitCode, Process } from "@effect/platform/CommandExecutor"
+import type { PlatformError } from "@effect/platform/Error"
+import * as internal from "@effect/platform/internal/command"
+import type { Sink } from "@effect/stream/Sink"
+import type { Stream } from "@effect/stream/Stream"
+
+/**
+ * @since 1.0.0
+ */
+export const CommandTypeId: unique symbol = internal.CommandTypeId
+
+/**
+ * @since 1.0.0
+ */
+export type CommandTypeId = typeof CommandTypeId
+
+/**
+ * @since 1.0.0
+ * @category models
+ */
+export type Command = StandardCommand | PipedCommand
+
+/**
+ * @since 1.0.0
+ */
+export declare namespace Command {
+  /**
+   * @since 1.0.0
+   * @category models
+   */
+  export interface Proto {
+    readonly [CommandTypeId]: CommandTypeId
+  }
+  /**
+   * Configures the pipe that is established between the parent and child
+   * processes' `stdin` stream.
+   *
+   * @since 1.0.0
+   * @category models
+   */
+  export type Input = CommandInput
+  /**
+   * Configures the pipes that are established between the parent and child
+   * processes `stderr` and `stdout` streams.
+   *
+   * @since 1.0.0
+   * @category models
+   */
+  export type Output = CommandOutput
+}
+
+/**
+ * Configures the pipe that is established between the parent and child
+ * processes' `stdin` stream.
+ *
+ * @since 1.0.0
+ * @category models
+ */
+export type CommandInput = Stream<never, PlatformError, Uint8Array>
+
+/**
+ * Configures the pipes that are established between the parent and child
+ * processes `stderr` and `stdout` streams.
+ *
+ * @since 1.0.0
+ * @category models
+ */
+export type CommandOutput = "inherit" | "pipe" | Sink<never, never, Uint8Array, never, Uint8Array>
+
+/**
+ * @since 1.0.0
+ * @category models
+ */
+export interface StandardCommand extends Command.Proto {
+  readonly _tag: "StandardCommand"
+  readonly command: string
+  readonly args: ReadonlyArray<string>
+  readonly env: HashMap<string, string>
+  readonly cwd: Option<string>
+  readonly stdin: Option<Command.Input>
+  readonly stdout: Command.Output
+  readonly stderr: Command.Output
+  readonly gid: Option<number>
+  readonly uid: Option<number>
+}
+
+/**
+ * @since 1.0.0
+ * @category models
+ */
+export interface PipedCommand extends Command.Proto {
+  readonly _tag: "PipedCommand"
+  readonly left: Command
+  readonly right: Command
+}
+
+/**
+ * Returns `true` if the specified value is a `Command`, otherwise returns
+ * `false`.
+ *
+ * @since 1.0.0
+ * @category refinements
+ */
+export const isCommand: (u: unknown) => u is Command = internal.isCommand
+
+/**
+ * Specify the environment variables that will be used when running this command.
+ *
+ * @since 1.0.0
+ * @category combinators
+ */
+export const env: {
+  (environment: Record<string, string>): (self: Command) => Command
+  (self: Command, environment: Record<string, string>): Command
+} = internal.env
+
+/**
+ * Returns the exit code of the command after the process has completed
+ * execution.
+ *
+ * @since 1.0.0
+ * @category execution
+ */
+export const exitCode: (self: Command) => Effect<CommandExecutor, PlatformError, ExitCode> = internal.exitCode
+
+/**
+ * Feed a string to standard input (default encoding of UTF-8).
+ *
+ * @since 1.0.0
+ * @category combinators
+ */
+export const feed: {
+  (input: string): (self: Command) => Command
+  (self: Command, input: string): Command
+} = internal.feed
+
+/**
+ * Flatten this command to a non-empty array of standard commands.
+ *
+ * * For a `StandardCommand`, this simply returns a `1` element array
+ * * For a `PipedCommand`, all commands in the pipe will be extracted out into
+ *   a array from left to right
+ *
+ * @since 1.0.0
+ * @category combinators
+ */
+export const flatten: (self: Command) => NonEmptyReadonlyArray<StandardCommand> = internal.flatten
+
+/**
+ * Runs the command returning the output as an array of lines with the specified
+ * encoding.
+ *
+ * @since 1.0.0
+ * @category execution
+ */
+export const lines: (
+  command: Command,
+  encoding?: string
+) => Effect<CommandExecutor, PlatformError, ReadonlyArray<string>> = internal.lines
+
+/**
+ * Create a command with the specified process name and an optional list of
+ * arguments.
+ *
+ * @since 1.0.0
+ * @category constructors
+ */
+export const make: (command: string, ...args: Array<string>) => Command = internal.make
+
+/**
+ * Pipe one command to another command from left to right.
+ *
+ * Conceptually, the equivalent of piping one shell command to another:
+ *
+ * ```sh
+ * command1 | command2
+ * ```
+ *
+ * @since 1.0.0
+ * @category combinators
+ */
+export const pipeTo: {
+  (into: Command): (self: Command) => Command
+  (self: Command, into: Command): Command
+} = internal.pipeTo
+
+/**
+ * Start running the command and return a handle to the running process.
+ *
+ * @since 1.0.0
+ * @category execution
+ */
+export const start: (command: Command) => Effect<CommandExecutor, PlatformError, Process> = internal.start
+
+/**
+ * Start running the command and return the output as a `Stream`.
+ *
+ * @since 1.0.0
+ * @category execution
+ */
+export const stream: (command: Command) => Stream<CommandExecutor, PlatformError, Uint8Array> = internal.stream
+
+/**
+ * Runs the command returning the output as an stream of lines with the
+ * specified encoding.
+ *
+ * @since 1.0.0
+ * @category execution
+ */
+export const streamLines: (command: Command) => Stream<CommandExecutor, PlatformError, string> = internal.streamLines
+
+/**
+ * Runs the command returning the entire output as a string with the
+ * specified encoding.
+ *
+ * If an encoding is not specified, the encoding will default to `utf-8`.
+ *
+ * @since 1.0.0
+ * @category execution
+ */
+export const string: {
+  (encoding?: string): (command: Command) => Effect<CommandExecutor, PlatformError, string>
+  (command: Command, encoding?: string): Effect<CommandExecutor, PlatformError, string>
+} = internal.string
+
+/**
+ * Specify the standard error stream for a command.
+ *
+ * @since 1.0.0
+ * @category combinators
+ */
+export const stderr: {
+  (stderr: Command.Output): (self: Command) => Command
+  (self: Command, stderr: Command.Output): Command
+} = internal.stderr
+
+/**
+ * Specify the standard input stream for a command.
+ *
+ * @since 1.0.0
+ * @category combinators
+ */
+export const stdin: {
+  (stdin: Command.Input): (self: Command) => Command
+  (self: Command, stdin: Command.Input): Command
+} = internal.stdin
+
+/**
+ * Specify the standard output stream for a command.
+ *
+ * @since 1.0.0
+ * @category combinators
+ */
+export const stdout: {
+  (stdout: Command.Output): (self: Command) => Command
+  (self: Command, stdout: Command.Output): Command
+} = internal.stdout
+
+/**
+ * Set the working directory that will be used when this command will be run.
+ *
+ * For piped commands, the working directory of each command will be set to the
+ * specified working directory.
+ *
+ * @since 1.0.0
+ * @category combinators
+ */
+export const workingDirectory: {
+  (cwd: string): (self: Command) => Command
+  (self: Command, cwd: string): Command
+} = internal.workingDirectory

package/src/CommandExecutor.ts

@@ -0,0 +1,191 @@
+/**
+ * @since 1.0.0
+ */
+import type * as Brand from "@effect/data/Brand"
+import type { Tag } from "@effect/data/Context"
+import type { Effect } from "@effect/io/Effect"
+import type { Command } from "@effect/platform/Command"
+import type { PlatformError } from "@effect/platform/Error"
+import * as internal from "@effect/platform/internal/commandExecutor"
+import type { Sink } from "@effect/stream/Sink"
+import type { Stream } from "@effect/stream/Stream"
+
+/**
+ * @since 1.0.0
+ * @category models
+ */
+export interface CommandExecutor {
+  /**
+   * Returns the exit code of the command after the process has completed
+   * execution.
+   */
+  readonly exitCode: (command: Command) => Effect<never, PlatformError, ExitCode>
+  /**
+   * Start running the command and return a handle to the running process.
+   */
+  readonly start: (command: Command) => Effect<never, PlatformError, Process>
+  /**
+   * Runs the command returning the entire output as a string with the
+   * specified encoding.
+   *
+   * If an encoding is not specified, the encoding will default to `utf-8`.
+   */
+  readonly string: (command: Command, encoding?: string) => Effect<never, PlatformError, string>
+  /**
+   * Runs the command returning the entire output as an array of lines.
+   *
+   * If an encoding is not specified, the encoding will default to `utf-8`.
+   */
+  readonly lines: (command: Command, encoding?: string) => Effect<never, PlatformError, ReadonlyArray<string>>
+  /**
+   * Runs the command returning the output as a `Stream`.
+   */
+  readonly stream: (command: Command) => Stream<never, PlatformError, Uint8Array>
+  /**
+   * Runs the command returning the output as a `Stream` of lines.
+   */
+  readonly streamLines: (command: Command, encoding?: string) => Stream<never, PlatformError, string>
+}
+
+/**
+ * @since 1.0.0
+ * @category tags
+ */
+export const CommandExecutor: Tag<CommandExecutor, CommandExecutor> = internal.CommandExecutor
+
+/**
+ * @since 1.0.0
+ * @category symbols
+ */
+export const ProcessTypeId: unique symbol = internal.ProcessTypeId
+
+/**
+ * @since 1.0.0
+ * @category symbols
+ */
+export type ProcessTypeId = typeof ProcessTypeId
+
+/**
+ * @since 1.0.0
+ * @category models
+ */
+export interface Process {
+  readonly [ProcessTypeId]: ProcessTypeId
+  /**
+   * The process identifier.
+   */
+  readonly pid: ProcessId
+  /**
+   * Waits for the process to exit and returns the `ExitCode` of the command
+   * that was run.
+   */
+  readonly exitCode: Effect<never, PlatformError, ExitCode>
+  /**
+   * Returns `true` if the process is still running, otherwise returns `false`.
+   */
+  readonly isRunning: Effect<never, PlatformError, boolean>
+  /**
+   * Kills the running process with the provided signal.
+   *
+   * If no signal is provided, the signal will defaults to `SIGTERM`.
+   */
+  readonly kill: (signal?: Signal) => Effect<never, PlatformError, void>
+  /**
+   * The standard error stream of the process.
+   */
+  readonly stderr: Stream<never, PlatformError, Uint8Array>
+  /**
+   * The standard input sink of the process.
+   */
+  readonly stdin: Sink<never, PlatformError, Uint8Array, never, void>
+  /**
+   * The standard output stream of the process.
+   */
+  readonly stdout: Stream<never, PlatformError, Uint8Array>
+}
+
+/**
+ * @since 1.0.0
+ * @category models
+ */
+export type ProcessId = Brand.Branded<number, "ProcessId">
+
+/**
+ * @since 1.0.0
+ */
+export namespace Process {
+  /**
+   * @since 1.0.0
+   * @category models
+   */
+  export type Id = ProcessId
+}
+
+/**
+ * @since 1.0.0
+ * @category models
+ */
+export type Signal =
+  | "SIGABRT"
+  | "SIGALRM"
+  | "SIGBUS"
+  | "SIGCHLD"
+  | "SIGCONT"
+  | "SIGFPE"
+  | "SIGHUP"
+  | "SIGILL"
+  | "SIGINT"
+  | "SIGIO"
+  | "SIGIOT"
+  | "SIGKILL"
+  | "SIGPIPE"
+  | "SIGPOLL"
+  | "SIGPROF"
+  | "SIGPWR"
+  | "SIGQUIT"
+  | "SIGSEGV"
+  | "SIGSTKFLT"
+  | "SIGSTOP"
+  | "SIGSYS"
+  | "SIGTERM"
+  | "SIGTRAP"
+  | "SIGTSTP"
+  | "SIGTTIN"
+  | "SIGTTOU"
+  | "SIGUNUSED"
+  | "SIGURG"
+  | "SIGUSR1"
+  | "SIGUSR2"
+  | "SIGVTALRM"
+  | "SIGWINCH"
+  | "SIGXCPU"
+  | "SIGXFSZ"
+  | "SIGBREAK"
+  | "SIGLOST"
+  | "SIGINFO"
+
+/**
+ * @since 1.0.0
+ * @category models
+ */
+export type ExitCode = Brand.Branded<number, "ExitCode">
+
+/**
+ * @since 1.0.0
+ * @category constructors
+ */
+export const ExitCode: Brand.Brand.Constructor<ExitCode> = internal.ExitCode
+
+/**
+ * @since 1.0.0
+ * @category constructors
+ */
+export const ProcessId: Brand.Brand.Constructor<Process.Id> = internal.ProcessId
+
+/**
+ * @since 1.0.0
+ * @category constructors
+ */
+export const makeExecutor: (
+  start: (command: Command) => Effect<never, PlatformError, Process>
+) => CommandExecutor = internal.makeExecutor

package/src/Error.ts

@@ -33,7 +33,7 @@ export namespace PlatformError {
   export interface Base extends Data.Case {
     readonly [PlatformErrorTypeId]: typeof PlatformErrorTypeId
     readonly _tag: string
-    readonly module: "FileSystem" | "Path"
+    readonly module: "Command" | "FileSystem" | "Path"
     readonly method: string
     readonly message: string
   }