@tianshu-ai/tianshu 0.3.0

package/plugins/web-search/node_modules/std-env/dist/index.d.cts

@@ -0,0 +1,92 @@
+type EnvObject = Record<string, string | undefined>;
+declare const env: EnvObject;
+declare const nodeENV: string;
+
+/** Value of process.platform */
+declare const platform: string;
+/** Detect if `CI` environment variable is set or a provider CI detected */
+declare const isCI: boolean;
+/** Detect if stdout.TTY is available */
+declare const hasTTY: boolean;
+/** Detect if global `window` object is available */
+declare const hasWindow: boolean;
+/** Detect if `DEBUG` environment variable is set */
+declare const isDebug: boolean;
+/** Detect if `NODE_ENV` environment variable is `test` */
+declare const isTest: boolean;
+/** Detect if `NODE_ENV` environment variable is `production` */
+declare const isProduction: boolean;
+/** Detect if `NODE_ENV` environment variable is `dev` or `development` */
+declare const isDevelopment: boolean;
+/** Detect if MINIMAL environment variable is set, running in CI or test or TTY is unavailable */
+declare const isMinimal: boolean;
+/** Detect if process.platform is Windows */
+declare const isWindows: boolean;
+/** Detect if process.platform is Linux */
+declare const isLinux: boolean;
+/** Detect if process.platform is macOS (darwin kernel) */
+declare const isMacOS: boolean;
+/** Color Support */
+declare const isColorSupported: boolean;
+/** Node.js versions */
+declare const nodeVersion: string | null;
+declare const nodeMajorVersion: number | null;
+
+interface Process extends Partial<Omit<typeof globalThis.process, "versions">> {
+    env: EnvObject;
+    versions: Record<string, string>;
+}
+declare const process: Process;
+
+type ProviderName = "" | "appveyor" | "aws_amplify" | "azure_pipelines" | "azure_static" | "appcircle" | "bamboo" | "bitbucket" | "bitrise" | "buddy" | "buildkite" | "circle" | "cirrus" | "cloudflare_pages" | "cloudflare_workers" | "codebuild" | "codefresh" | "drone" | "drone" | "dsari" | "github_actions" | "gitlab" | "gocd" | "layerci" | "hudson" | "jenkins" | "magnum" | "netlify" | "nevercode" | "render" | "sail" | "semaphore" | "screwdriver" | "shippable" | "solano" | "strider" | "teamcity" | "travis" | "vercel" | "appcenter" | "codesandbox" | "stackblitz" | "stormkit" | "cleavr" | "zeabur" | "codesphere" | "railway" | "deno-deploy" | "firebase_app_hosting";
+type ProviderInfo = {
+    name: ProviderName;
+    ci?: boolean;
+    [meta: string]: any;
+};
+/** Current provider info */
+declare const providerInfo: ProviderInfo;
+declare const provider: ProviderName;
+
+type RuntimeName = "workerd" | "deno" | "netlify" | "node" | "bun" | "edge-light" | "fastly" | "";
+type RuntimeInfo = {
+    name: RuntimeName;
+};
+/**
+ * Indicates if running in Node.js or a Node.js compatible runtime.
+ *
+ * **Note:** When running code in Bun and Deno with Node.js compatibility mode, `isNode` flag will be also `true`, indicating running in a Node.js compatible runtime.
+ *
+ * Use `runtime === "node"` if you need strict check for Node.js runtime.
+ */
+declare const isNode: boolean;
+/**
+ * Indicates if running in Bun runtime.
+ */
+declare const isBun: boolean;
+/**
+ * Indicates if running in Deno runtime.
+ */
+declare const isDeno: boolean;
+/**
+ * Indicates if running in Fastly runtime.
+ */
+declare const isFastly: boolean;
+/**
+ * Indicates if running in Netlify runtime.
+ */
+declare const isNetlify: boolean;
+/**
+ *
+ * Indicates if running in EdgeLight (Vercel Edge) runtime.
+ */
+declare const isEdgeLight: boolean;
+/**
+ * Indicates if running in Cloudflare Workers runtime.
+ */
+declare const isWorkerd: boolean;
+declare const runtimeInfo: RuntimeInfo | undefined;
+declare const runtime: RuntimeName;
+
+export { env, hasTTY, hasWindow, isBun, isCI, isColorSupported, isDebug, isDeno, isDevelopment, isEdgeLight, isFastly, isLinux, isMacOS, isMinimal, isNetlify, isNode, isProduction, isTest, isWindows, isWorkerd, nodeENV, nodeMajorVersion, nodeVersion, platform, process, provider, providerInfo, runtime, runtimeInfo };
+export type { EnvObject, Process, ProviderInfo, ProviderName, RuntimeInfo, RuntimeName };

package/plugins/web-search/node_modules/std-env/dist/index.d.mts

@@ -0,0 +1,92 @@
+type EnvObject = Record<string, string | undefined>;
+declare const env: EnvObject;
+declare const nodeENV: string;
+
+/** Value of process.platform */
+declare const platform: string;
+/** Detect if `CI` environment variable is set or a provider CI detected */
+declare const isCI: boolean;
+/** Detect if stdout.TTY is available */
+declare const hasTTY: boolean;
+/** Detect if global `window` object is available */
+declare const hasWindow: boolean;
+/** Detect if `DEBUG` environment variable is set */
+declare const isDebug: boolean;
+/** Detect if `NODE_ENV` environment variable is `test` */
+declare const isTest: boolean;
+/** Detect if `NODE_ENV` environment variable is `production` */
+declare const isProduction: boolean;
+/** Detect if `NODE_ENV` environment variable is `dev` or `development` */
+declare const isDevelopment: boolean;
+/** Detect if MINIMAL environment variable is set, running in CI or test or TTY is unavailable */
+declare const isMinimal: boolean;
+/** Detect if process.platform is Windows */
+declare const isWindows: boolean;
+/** Detect if process.platform is Linux */
+declare const isLinux: boolean;
+/** Detect if process.platform is macOS (darwin kernel) */
+declare const isMacOS: boolean;
+/** Color Support */
+declare const isColorSupported: boolean;
+/** Node.js versions */
+declare const nodeVersion: string | null;
+declare const nodeMajorVersion: number | null;
+
+interface Process extends Partial<Omit<typeof globalThis.process, "versions">> {
+    env: EnvObject;
+    versions: Record<string, string>;
+}
+declare const process: Process;
+
+type ProviderName = "" | "appveyor" | "aws_amplify" | "azure_pipelines" | "azure_static" | "appcircle" | "bamboo" | "bitbucket" | "bitrise" | "buddy" | "buildkite" | "circle" | "cirrus" | "cloudflare_pages" | "cloudflare_workers" | "codebuild" | "codefresh" | "drone" | "drone" | "dsari" | "github_actions" | "gitlab" | "gocd" | "layerci" | "hudson" | "jenkins" | "magnum" | "netlify" | "nevercode" | "render" | "sail" | "semaphore" | "screwdriver" | "shippable" | "solano" | "strider" | "teamcity" | "travis" | "vercel" | "appcenter" | "codesandbox" | "stackblitz" | "stormkit" | "cleavr" | "zeabur" | "codesphere" | "railway" | "deno-deploy" | "firebase_app_hosting";
+type ProviderInfo = {
+    name: ProviderName;
+    ci?: boolean;
+    [meta: string]: any;
+};
+/** Current provider info */
+declare const providerInfo: ProviderInfo;
+declare const provider: ProviderName;
+
+type RuntimeName = "workerd" | "deno" | "netlify" | "node" | "bun" | "edge-light" | "fastly" | "";
+type RuntimeInfo = {
+    name: RuntimeName;
+};
+/**
+ * Indicates if running in Node.js or a Node.js compatible runtime.
+ *
+ * **Note:** When running code in Bun and Deno with Node.js compatibility mode, `isNode` flag will be also `true`, indicating running in a Node.js compatible runtime.
+ *
+ * Use `runtime === "node"` if you need strict check for Node.js runtime.
+ */
+declare const isNode: boolean;
+/**
+ * Indicates if running in Bun runtime.
+ */
+declare const isBun: boolean;
+/**
+ * Indicates if running in Deno runtime.
+ */
+declare const isDeno: boolean;
+/**
+ * Indicates if running in Fastly runtime.
+ */
+declare const isFastly: boolean;
+/**
+ * Indicates if running in Netlify runtime.
+ */
+declare const isNetlify: boolean;
+/**
+ *
+ * Indicates if running in EdgeLight (Vercel Edge) runtime.
+ */
+declare const isEdgeLight: boolean;
+/**
+ * Indicates if running in Cloudflare Workers runtime.
+ */
+declare const isWorkerd: boolean;
+declare const runtimeInfo: RuntimeInfo | undefined;
+declare const runtime: RuntimeName;
+
+export { env, hasTTY, hasWindow, isBun, isCI, isColorSupported, isDebug, isDeno, isDevelopment, isEdgeLight, isFastly, isLinux, isMacOS, isMinimal, isNetlify, isNode, isProduction, isTest, isWindows, isWorkerd, nodeENV, nodeMajorVersion, nodeVersion, platform, process, provider, providerInfo, runtime, runtimeInfo };
+export type { EnvObject, Process, ProviderInfo, ProviderName, RuntimeInfo, RuntimeName };

package/plugins/web-search/node_modules/std-env/dist/index.d.ts

@@ -0,0 +1,92 @@
+type EnvObject = Record<string, string | undefined>;
+declare const env: EnvObject;
+declare const nodeENV: string;
+
+/** Value of process.platform */
+declare const platform: string;
+/** Detect if `CI` environment variable is set or a provider CI detected */
+declare const isCI: boolean;
+/** Detect if stdout.TTY is available */
+declare const hasTTY: boolean;
+/** Detect if global `window` object is available */
+declare const hasWindow: boolean;
+/** Detect if `DEBUG` environment variable is set */
+declare const isDebug: boolean;
+/** Detect if `NODE_ENV` environment variable is `test` */
+declare const isTest: boolean;
+/** Detect if `NODE_ENV` environment variable is `production` */
+declare const isProduction: boolean;
+/** Detect if `NODE_ENV` environment variable is `dev` or `development` */
+declare const isDevelopment: boolean;
+/** Detect if MINIMAL environment variable is set, running in CI or test or TTY is unavailable */
+declare const isMinimal: boolean;
+/** Detect if process.platform is Windows */
+declare const isWindows: boolean;
+/** Detect if process.platform is Linux */
+declare const isLinux: boolean;
+/** Detect if process.platform is macOS (darwin kernel) */
+declare const isMacOS: boolean;
+/** Color Support */
+declare const isColorSupported: boolean;
+/** Node.js versions */
+declare const nodeVersion: string | null;
+declare const nodeMajorVersion: number | null;
+
+interface Process extends Partial<Omit<typeof globalThis.process, "versions">> {
+    env: EnvObject;
+    versions: Record<string, string>;
+}
+declare const process: Process;
+
+type ProviderName = "" | "appveyor" | "aws_amplify" | "azure_pipelines" | "azure_static" | "appcircle" | "bamboo" | "bitbucket" | "bitrise" | "buddy" | "buildkite" | "circle" | "cirrus" | "cloudflare_pages" | "cloudflare_workers" | "codebuild" | "codefresh" | "drone" | "drone" | "dsari" | "github_actions" | "gitlab" | "gocd" | "layerci" | "hudson" | "jenkins" | "magnum" | "netlify" | "nevercode" | "render" | "sail" | "semaphore" | "screwdriver" | "shippable" | "solano" | "strider" | "teamcity" | "travis" | "vercel" | "appcenter" | "codesandbox" | "stackblitz" | "stormkit" | "cleavr" | "zeabur" | "codesphere" | "railway" | "deno-deploy" | "firebase_app_hosting";
+type ProviderInfo = {
+    name: ProviderName;
+    ci?: boolean;
+    [meta: string]: any;
+};
+/** Current provider info */
+declare const providerInfo: ProviderInfo;
+declare const provider: ProviderName;
+
+type RuntimeName = "workerd" | "deno" | "netlify" | "node" | "bun" | "edge-light" | "fastly" | "";
+type RuntimeInfo = {
+    name: RuntimeName;
+};
+/**
+ * Indicates if running in Node.js or a Node.js compatible runtime.
+ *
+ * **Note:** When running code in Bun and Deno with Node.js compatibility mode, `isNode` flag will be also `true`, indicating running in a Node.js compatible runtime.
+ *
+ * Use `runtime === "node"` if you need strict check for Node.js runtime.
+ */
+declare const isNode: boolean;
+/**
+ * Indicates if running in Bun runtime.
+ */
+declare const isBun: boolean;
+/**
+ * Indicates if running in Deno runtime.
+ */
+declare const isDeno: boolean;
+/**
+ * Indicates if running in Fastly runtime.
+ */
+declare const isFastly: boolean;
+/**
+ * Indicates if running in Netlify runtime.
+ */
+declare const isNetlify: boolean;
+/**
+ *
+ * Indicates if running in EdgeLight (Vercel Edge) runtime.
+ */
+declare const isEdgeLight: boolean;
+/**
+ * Indicates if running in Cloudflare Workers runtime.
+ */
+declare const isWorkerd: boolean;
+declare const runtimeInfo: RuntimeInfo | undefined;
+declare const runtime: RuntimeName;
+
+export { env, hasTTY, hasWindow, isBun, isCI, isColorSupported, isDebug, isDeno, isDevelopment, isEdgeLight, isFastly, isLinux, isMacOS, isMinimal, isNetlify, isNode, isProduction, isTest, isWindows, isWorkerd, nodeENV, nodeMajorVersion, nodeVersion, platform, process, provider, providerInfo, runtime, runtimeInfo };
+export type { EnvObject, Process, ProviderInfo, ProviderName, RuntimeInfo, RuntimeName };

package/plugins/web-search/node_modules/std-env/dist/index.mjs

@@ -0,0 +1 @@
+const r=Object.create(null),i=e=>globalThis.process?.env||import.meta.env||globalThis.Deno?.env.toObject()||globalThis.__env__||(e?r:globalThis),o=new Proxy(r,{get(e,s){return i()[s]??r[s]},has(e,s){const E=i();return s in E||s in r},set(e,s,E){const B=i(!0);return B[s]=E,!0},deleteProperty(e,s){if(!s)return!1;const E=i(!0);return delete E[s],!0},ownKeys(){const e=i(!0);return Object.keys(e)}}),t=typeof process<"u"&&process.env&&process.env.NODE_ENV||"",f=[["APPVEYOR"],["AWS_AMPLIFY","AWS_APP_ID",{ci:!0}],["AZURE_PIPELINES","SYSTEM_TEAMFOUNDATIONCOLLECTIONURI"],["AZURE_STATIC","INPUT_AZURE_STATIC_WEB_APPS_API_TOKEN"],["APPCIRCLE","AC_APPCIRCLE"],["BAMBOO","bamboo_planKey"],["BITBUCKET","BITBUCKET_COMMIT"],["BITRISE","BITRISE_IO"],["BUDDY","BUDDY_WORKSPACE_ID"],["BUILDKITE"],["CIRCLE","CIRCLECI"],["CIRRUS","CIRRUS_CI"],["CLOUDFLARE_PAGES","CF_PAGES",{ci:!0}],["CLOUDFLARE_WORKERS","WORKERS_CI",{ci:!0}],["CODEBUILD","CODEBUILD_BUILD_ARN"],["CODEFRESH","CF_BUILD_ID"],["DRONE"],["DRONE","DRONE_BUILD_EVENT"],["DSARI"],["GITHUB_ACTIONS"],["GITLAB","GITLAB_CI"],["GITLAB","CI_MERGE_REQUEST_ID"],["GOCD","GO_PIPELINE_LABEL"],["LAYERCI"],["HUDSON","HUDSON_URL"],["JENKINS","JENKINS_URL"],["MAGNUM"],["NETLIFY"],["NETLIFY","NETLIFY_LOCAL",{ci:!1}],["NEVERCODE"],["RENDER"],["SAIL","SAILCI"],["SEMAPHORE"],["SCREWDRIVER"],["SHIPPABLE"],["SOLANO","TDDIUM"],["STRIDER"],["TEAMCITY","TEAMCITY_VERSION"],["TRAVIS"],["VERCEL","NOW_BUILDER"],["VERCEL","VERCEL",{ci:!1}],["VERCEL","VERCEL_ENV",{ci:!1}],["APPCENTER","APPCENTER_BUILD_ID"],["CODESANDBOX","CODESANDBOX_SSE",{ci:!1}],["CODESANDBOX","CODESANDBOX_HOST",{ci:!1}],["STACKBLITZ"],["STORMKIT"],["CLEAVR"],["ZEABUR"],["CODESPHERE","CODESPHERE_APP_ID",{ci:!0}],["RAILWAY","RAILWAY_PROJECT_ID"],["RAILWAY","RAILWAY_SERVICE_ID"],["DENO-DEPLOY","DENO_DEPLOYMENT_ID"],["FIREBASE_APP_HOSTING","FIREBASE_APP_HOSTING",{ci:!0}]];function b(){if(globalThis.process?.env)for(const e of f){const s=e[1]||e[0];if(globalThis.process?.env[s])return{name:e[0].toLowerCase(),...e[2]}}return globalThis.process?.env?.SHELL==="/bin/jsh"&&globalThis.process?.versions?.webcontainer?{name:"stackblitz",ci:!1}:{name:"",ci:!1}}const l=b(),p=l.name;function n(e){return e?e!=="false":!1}const I=globalThis.process?.platform||"",T=n(o.CI)||l.ci!==!1,R=n(globalThis.process?.stdout&&globalThis.process?.stdout.isTTY),U=typeof window<"u",d=n(o.DEBUG),a=t==="test"||n(o.TEST),g=t==="production",h=t==="dev"||t==="development",v=n(o.MINIMAL)||T||a||!R,A=/^win/i.test(I),M=/^linux/i.test(I),m=/^darwin/i.test(I),Y=!n(o.NO_COLOR)&&(n(o.FORCE_COLOR)||(R||A)&&o.TERM!=="dumb"||T),C=(globalThis.process?.versions?.node||"").replace(/^v/,"")||null,V=Number(C?.split(".")[0])||null,W=globalThis.process||Object.create(null),_={versions:{}},y=new Proxy(W,{get(e,s){if(s==="env")return o;if(s in e)return e[s];if(s in _)return _[s]}}),O=globalThis.process?.release?.name==="node",c=!!globalThis.Bun||!!globalThis.process?.versions?.bun,D=!!globalThis.Deno,L=!!globalThis.fastly,S=!!globalThis.Netlify,u=!!globalThis.EdgeRuntime,N=globalThis.navigator?.userAgent==="Cloudflare-Workers",F=[[S,"netlify"],[u,"edge-light"],[N,"workerd"],[L,"fastly"],[D,"deno"],[c,"bun"],[O,"node"]];function G(){const e=F.find(s=>s[0]);if(e)return{name:e[1]}}const P=G(),K=P?.name||"";export{o as env,R as hasTTY,U as hasWindow,c as isBun,T as isCI,Y as isColorSupported,d as isDebug,D as isDeno,h as isDevelopment,u as isEdgeLight,L as isFastly,M as isLinux,m as isMacOS,v as isMinimal,S as isNetlify,O as isNode,g as isProduction,a as isTest,A as isWindows,N as isWorkerd,t as nodeENV,V as nodeMajorVersion,C as nodeVersion,I as platform,y as process,p as provider,l as providerInfo,K as runtime,P as runtimeInfo};

package/plugins/web-search/node_modules/std-env/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "std-env",
+  "version": "3.10.0",
+  "description": "Runtime agnostic JS utils",
+  "repository": "unjs/std-env",
+  "license": "MIT",
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    "types": "./dist/index.d.ts",
+    "import": "./dist/index.mjs",
+    "require": "./dist/index.cjs"
+  },
+  "main": "./dist/index.cjs",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "unbuild",
+    "dev": "vitest",
+    "lint": "eslint . && prettier -c src test",
+    "lint:fix": "eslint --fix . && prettier -w src test",
+    "prepack": "unbuild",
+    "play:bun": "bun playground/bun.ts",
+    "play:deno": "pnpm build && deno run -A playground/deno.ts",
+    "play:node": "pnpm build && node playground/node.mjs",
+    "release": "pnpm test && changelogen --release && npm publish && git push --follow-tags",
+    "test": "pnpm lint && pnpm typecheck && vitest run --coverage",
+    "typecheck": "tsc --noEmit"
+  },
+  "devDependencies": {
+    "@types/node": "^24.7.2",
+    "@vitest/coverage-v8": "^3.2.4",
+    "changelogen": "^0.6.2",
+    "esbuild": "^0.25.10",
+    "eslint": "^9.37.0",
+    "eslint-config-unjs": "^0.5.0",
+    "prettier": "^3.6.2",
+    "rollup": "^4.52.4",
+    "typescript": "^5.9.3",
+    "unbuild": "^3.6.1",
+    "vitest": "^3.2.4"
+  },
+  "packageManager": "pnpm@10.18.2"
+}

package/plugins/web-search/node_modules/tinyexec/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Tinylibs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/plugins/web-search/node_modules/tinyexec/README.md

@@ -0,0 +1,256 @@
+# tinyexec 📟
+
+> A minimal package for executing commands
+
+This package was created to provide a minimal way of interacting with child
+processes without having to manually deal with streams, piping, etc.
+
+## Installing
+
+```sh
+$ npm i -S tinyexec
+```
+
+## Usage
+
+A process can be spawned and awaited like so:
+
+```ts
+import {x} from 'tinyexec';
+
+const result = await x('ls', ['-l']);
+
+// result.stdout - the stdout as a string
+// result.stderr - the stderr as a string
+// result.exitCode - the process exit code as a number
+```
+
+You may also iterate over the lines of output via an async loop:
+
+```ts
+import {x} from 'tinyexec';
+
+const proc = x('ls', ['-l']);
+
+for await (const line of proc) {
+  // line will be from stderr/stdout in the order you'd see it in a term
+}
+```
+
+### Options
+
+Options can be passed to have finer control over spawning of the process:
+
+```ts
+await x('ls', [], {
+  timeout: 1000
+});
+```
+
+The options object can have the following properties:
+
+- `signal` - an `AbortSignal` to allow aborting of the execution
+- `timeout` - time in milliseconds at which the process will be forceably killed
+- `persist` - if `true`, the process will continue after the host exits
+- `stdin` - another `Result` can be used as the input to this process
+- `nodeOptions` - any valid options to node's underlying `spawn` function
+- `throwOnError` - if true, non-zero exit codes will throw an error
+
+### Piping to another process
+
+You can pipe a process to another via the `pipe` method:
+
+```ts
+const proc1 = x('ls', ['-l']);
+const proc2 = proc1.pipe('grep', ['.js']);
+const result = await proc2;
+
+console.log(result.stdout);
+```
+
+`pipe` takes the same options as a regular execution. For example, you can
+pass a timeout to the pipe call:
+
+```ts
+proc1.pipe('grep', ['.js'], {
+  timeout: 2000
+});
+```
+
+### Killing a process
+
+You can kill the process via the `kill` method:
+
+```ts
+const proc = x('ls');
+
+proc.kill();
+
+// or with a signal
+proc.kill('SIGHUP');
+```
+
+### Node modules/binaries
+
+By default, node's available binaries from `node_modules` will be accessible
+in your command.
+
+For example, in a repo which has `eslint` installed:
+
+```ts
+await x('eslint', ['.']);
+```
+
+In this example, `eslint` will come from the locally installed `node_modules`.
+
+### Using an abort signal
+
+An abort signal can be passed to a process in order to abort it at a later
+time. This will result in the process being killed and `aborted` being set
+to `true`.
+
+```ts
+const aborter = new AbortController();
+const proc = x('node', ['./foo.mjs'], {
+  signal: aborter.signal
+});
+
+// elsewhere...
+aborter.abort();
+
+await proc;
+
+proc.aborted; // true
+proc.killed; // true
+```
+
+### Using with command strings
+
+If you need to continue supporting commands as strings (e.g. "command arg0 arg1"),
+you can use [args-tokenizer](https://github.com/TrySound/args-tokenizer),
+a lightweight library for parsing shell command strings into an array.
+
+```ts
+import {x} from 'tinyexec';
+import {tokenizeArgs} from 'args-tokenizer';
+
+const commandString = 'echo "Hello, World!"';
+const [command, ...args] = tokenizeArgs(commandString);
+const result = await x(command, args);
+
+result.stdout; // Hello, World!
+```
+
+## API
+
+Calling `x(command[, args])` returns an awaitable `Result` which has the
+following API methods and properties available:
+
+### `pipe(command[, args[, options]])`
+
+Pipes the current command to another. For example:
+
+```ts
+x('ls', ['-l'])
+  .pipe('grep', ['js']);
+```
+
+The parameters are as follows:
+
+- `command` - the command to execute (_without any arguments_)
+- `args` - an array of arguments
+- `options` - options object
+
+### `process`
+
+The underlying node `ChildProcess`. For example:
+
+```ts
+const proc = x('ls');
+
+proc.process; // ChildProcess;
+```
+
+### `kill([signal])`
+
+Kills the current process with the specified signal. By default, this will
+use the `SIGTERM` signal.
+
+For example:
+
+```ts
+const proc = x('ls');
+
+proc.kill();
+```
+
+### `pid`
+
+The current process ID. For example:
+
+```ts
+const proc = x('ls');
+
+proc.pid; // number
+```
+
+### `aborted`
+
+Whether the process has been aborted or not (via the `signal` originally
+passed in the options object).
+
+For example:
+
+```ts
+const proc = x('ls');
+
+proc.aborted; // bool
+```
+
+### `killed`
+
+Whether the process has been killed or not (e.g. via `kill()` or an abort
+signal).
+
+For example:
+
+```ts
+const proc = x('ls');
+
+proc.killed; // bool
+```
+
+### `exitCode`
+
+The exit code received when the process completed execution.
+
+For example:
+
+```ts
+const proc = x('ls');
+
+proc.exitCode; // number (e.g. 1)
+```
+
+## Comparison with other libraries
+
+`tinyexec` aims to provide a lightweight layer on top of Node's own
+`child_process` API.
+
+Some clear benefits compared to other libraries are that `tinyexec` will be much lighter, have a much
+smaller footprint and will have a less abstract interface (less "magic"). It
+will also have equal security and cross-platform support to popular
+alternatives.
+
+There are various features other libraries include which we are unlikely
+to ever implement, as they would prevent us from providing a lightweight layer.
+
+For example, if you'd like write scripts rather than individual commands, and
+prefer to use templating, we'd definitely recommend
+[zx](https://github.com/google/zx). zx is a much higher level library which
+does some of the same work `tinyexec` does but behind a template string
+interface.
+
+Similarly, libraries like `execa` will provide helpers for various things
+like passing files as input to processes. We opt not to support features like
+this since many of them are easy to do yourself (using Node's own APIs).