@atelierai/uco 1.0.0

package/dist/util/tool-payload.js

@@ -0,0 +1,58 @@
+const TOOL_PAYLOAD_WRAPPER_KEYS = [
+    'structured',
+    'Structured',
+    'structuredContent',
+    'StructuredContent',
+    'result',
+    'Result',
+    'value',
+    'Value',
+];
+const DEFAULT_MAX_DEPTH = 8;
+/**
+ * Visit only the bridge's known response wrappers. This intentionally does not
+ * recurse through arbitrary result data, so an application object's `Ok`
+ * property cannot be mistaken for the tool's own status contract.
+ */
+export function toolPayloadRecords(value, maxDepth = DEFAULT_MAX_DEPTH) {
+    const records = [];
+    const pending = [{ value, depth: 0 }];
+    const seen = new WeakSet();
+    while (pending.length > 0) {
+        const current = pending.shift();
+        if (!isRecord(current.value) || seen.has(current.value))
+            continue;
+        seen.add(current.value);
+        records.push(current.value);
+        if (current.depth >= maxDepth)
+            continue;
+        for (const key of TOOL_PAYLOAD_WRAPPER_KEYS) {
+            const nested = current.value[key];
+            if (isRecord(nested))
+                pending.push({ value: nested, depth: current.depth + 1 });
+        }
+    }
+    return records;
+}
+/** Follow the first known wrapper at each level and return the deepest record. */
+export function unwrapToolPayload(value, maxDepth = DEFAULT_MAX_DEPTH) {
+    let current = value;
+    const seen = new WeakSet();
+    for (let depth = 0; depth <= maxDepth; depth += 1) {
+        if (!isRecord(current) || seen.has(current))
+            return {};
+        seen.add(current);
+        const record = current;
+        const next = TOOL_PAYLOAD_WRAPPER_KEYS
+            .map((key) => record[key])
+            .find(isRecord);
+        if (next === undefined)
+            return record;
+        current = next;
+    }
+    return {};
+}
+function isRecord(value) {
+    return value !== null && typeof value === 'object' && !Array.isArray(value);
+}
+//# sourceMappingURL=tool-payload.js.map

package/dist/util/tool-payload.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tool-payload.js","sourceRoot":"","sources":["../../src/util/tool-payload.ts"],"names":[],"mappings":"AAAA,MAAM,yBAAyB,GAAG;IAChC,YAAY;IACZ,YAAY;IACZ,mBAAmB;IACnB,mBAAmB;IACnB,QAAQ;IACR,QAAQ;IACR,OAAO;IACP,OAAO;CACC,CAAC;AAEX,MAAM,iBAAiB,GAAG,CAAC,CAAC;AAE5B;;;;GAIG;AACH,MAAM,UAAU,kBAAkB,CAChC,KAAc,EACd,QAAQ,GAAG,iBAAiB;IAE5B,MAAM,OAAO,GAAmC,EAAE,CAAC;IACnD,MAAM,OAAO,GAA6C,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;IAChF,MAAM,IAAI,GAAG,IAAI,OAAO,EAAU,CAAC;IAEnC,OAAO,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC1B,MAAM,OAAO,GAAG,OAAO,CAAC,KAAK,EAAG,CAAC;QACjC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC;YAAE,SAAS;QAClE,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACxB,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC5B,IAAI,OAAO,CAAC,KAAK,IAAI,QAAQ;YAAE,SAAS;QAExC,KAAK,MAAM,GAAG,IAAI,yBAAyB,EAAE,CAAC;YAC5C,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAClC,IAAI,QAAQ,CAAC,MAAM,CAAC;gBAAE,OAAO,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,GAAG,CAAC,EAAE,CAAC,CAAC;QAClF,CAAC;IACH,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,kFAAkF;AAClF,MAAM,UAAU,iBAAiB,CAC/B,KAAc,EACd,QAAQ,GAAG,iBAAiB;IAE5B,IAAI,OAAO,GAAG,KAAK,CAAC;IACpB,MAAM,IAAI,GAAG,IAAI,OAAO,EAAU,CAAC;IAEnC,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,IAAI,QAAQ,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;QAClD,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC;YAAE,OAAO,EAAE,CAAC;QACvD,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAClB,MAAM,MAAM,GAAG,OAAO,CAAC;QACvB,MAAM,IAAI,GAAG,yBAAyB;aACnC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;aACzB,IAAI,CAAC,QAAQ,CAAC,CAAC;QAClB,IAAI,IAAI,KAAK,SAAS;YAAE,OAAO,MAAM,CAAC;QACtC,OAAO,GAAG,IAAI,CAAC;IACjB,CAAC;IAED,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9E,CAAC"}

package/docs/INSTALL.zh-CN.md

@@ -0,0 +1,175 @@
+# uco 离线安装与使用指南
+
+> 本指南面向收到 `uco-<version>.tgz` 离线安装包的用户。整个安装过程**无需联网**，不依赖 npm 仓库、OpenUPM 或任何 Git 仓库。
+
+## 1. uco 是什么
+
+uco 是 Unity 的命令行副驾驶。它让你（或任意 AI 编程助手）通过普通 shell 命令驱动 Unity，覆盖两个层面：
+
+- **编辑器 / 项目生命周期**：安装 Unity、创建项目、构建、测试等。
+- **对运行中 Unity 编辑器的实时自动化**：通过纯 REST 查询工具、执行脚本、读写场景与对象。
+
+特点：AI 只需调用 shell 命令，不在会话里注册 MCP 工具表，保持 agent 接口精简；运行时走纯 REST（`POST /api/tools/{name}`），由 Unity 插件启动的本地工具服务器承接。
+
+## 2. 你会收到什么
+
+一个自包含的 `uco-<version>.tgz`，内含：
+
+| 组成 | 说明 |
+|---|---|
+| uco CLI | 命令行程序本体（已编译） |
+| npm 依赖 | chalk / commander / kleur / yocto-spinner，已内置，安装时不再联网 |
+| Node 工具服务器 | 已编译的 Node.js 服务器，跨平台，由 Unity 插件自动拉起 |
+| NuGet DLL | Unity 插件运行所需的依赖库 |
+| Unity 插件源 | `com.atelierai.unity.copilot`（Unity Copilot 插件） |
+
+## 3. 环境要求
+
+- **操作系统**：Windows / macOS / Linux（服务器为 Node.js，天然跨平台）
+- **Node.js**：20 或更高（安装与运行时服务器都需要）
+- **Unity**：2022.3 或更高
+- 不需要 .NET SDK、Visual Studio 或任何 C++ 编译环境
+
+检查 Node：
+
+```bash
+node --version    # 应显示 v20 或更高
+```
+
+## 4. 安装步骤
+
+### 4.1 安装 uco 命令
+
+```bash
+npm install -g @atelierai/uco-<version>.tgz
+```
+
+完全离线，依赖已内置。完成后 `uco` 命令全局可用，验证：
+
+```bash
+uco --version
+uco --help
+```
+
+### 4.2 让 AI 编程助手认识 uco（可选但推荐）
+
+如果你打算让 AI 编程助手（默认 Claude Code）通过 uco 驱动 Unity，先把 uco 的 Skills 装进助手的 skills 目录。这是打破"鸡生蛋"的引导步骤——在还没有任何 Unity 项目、没有运行中的服务器之前，让助手先掌握 uco 的命令面。
+
+```bash
+uco init                            # 把三个 uco Skills 装进 ./.claude/skills（Claude Code）
+# uco init <目录>                   # 指定别的工作目录
+# uco init --agent codex            # 用别的助手的 skills 目录（.agents/skills）
+# uco init --agent claude-code,cursor  # 一次给多个助手安装
+# uco init --list                   # 查看所有支持的助手（含检测路径）
+```
+
+不带 `--agent` 时，init 会自己挑助手集合：交互式终端下弹出编号多选（直接回车接受预选项），非交互模式下安装目标处已检测到的所有助手目录（都没有则回退 Claude Code）。
+
+装完后**重启助手会话**——Claude Code 在启动时扫描 skills 目录。此后助手就能自行驱动整条流程：`uco install-unity` → `uco create-project` → `uco install` → `uco open` → `uco setup-skills`。
+
+`uco init` 写入的是静态 Skill 模板，ownership manifest 与 `uco setup-skills` 一致，所以后续接入项目后跑 `setup-skills`（编译 live 工具目录，需要运行中的 Editor）会原地刷新这些 skill。重复运行 `uco init` 是安全的无操作。
+
+每次成功安装都会记录到 `.uco/install-manifest.json`（选中的助手、各自的 skills 路径、以及是否安装过 Unity 工具链）。用更小的 `--agent` 集合重跑 `uco init` 会移除被取消选中助手的 uco 自有 skill 目录——绝不碰用户文件。
+
+### 4.2.1 升级已安装目标
+
+升级 uco 包本身之后（`npm i -g @atelierai/uco@latest`），用一条命令刷新 uco 装进目标的所有内容：
+
+```bash
+uco update [目标目录]               # 默认：当前目录
+# uco update --dry-run              # 只打印计划改动，不写入
+# uco update --force                # 即使内容一致也重新生成所有已记录助手
+# uco update --skip-unity           # 不动 Unity 插件包与 NuGet DLL
+# uco update --skip-mcp-config      # 不读写任何助手的 MCP 配置
+```
+
+`uco update` 依照 install manifest 刷新：每个已安装助手的 Skills 和共享的 `.uco/agent-runtime`（按内容差异驱动——无需运行中的 Unity Editor，且 `setup-skills` 产出的 live 工具目录不会被回退）；对 bundle 来源的安装，把 Unity 插件包与 NuGet DLL 作为**一套匹配集**整体重刷（旧 DLL 导致的 CS0246 编译错误不可能经 uco 发生）；并依据项目当前的 `UserSettings/uco-config.json` 重新对齐每个助手的 MCP 配置。命令幂等——紧接着再跑一次会输出 `Already up to date.`；绝不会自动安装未记录的助手（新检测到的助手目录只以提示形式出现，指向 `uco init --agent <id>`）。早于 manifest 的存量安装会在首次 update 时自动迁移。
+
+### 4.3 接入一个 Unity 项目
+
+把 uco 运行时（插件 + 依赖库 + 配置）装进你的 Unity 项目：
+
+```bash
+uco install "D:\YourUnityProject"
+```
+
+该命令幂等，可重复运行。它会：
+
+- 把插件源嵌入项目 `Packages/com.atelierai.unity.copilot/`
+- 拷贝 NuGet DLL 到 `Assets/Plugins/NuGet/`
+- 写入初始配置 `UserSettings/uco-config.json`（含端口与随机 token）
+
+服务器本体不在项目内暂存——Unity 插件首次启动时会自动拉起 Node 服务器。
+
+想先看清会做哪些改动而不实际写入，加 `--dry-run`：
+
+```bash
+uco install "D:\YourUnityProject" --dry-run
+```
+
+### 4.4 启动 Unity 并验证连通
+
+1. 用 Unity Hub 打开该项目一次（首次会编译插件脚本，请等待编译完成）。
+2. 插件会自动启动本地工具服务器。
+3. 在**项目目录**下验证桥接是否打通：
+
+```bash
+cd "D:\YourUnityProject"
+uco ping
+```
+
+看到响应即表示 REST 桥已通，可以开始自动化操作了。
+
+## 5. 常用命令速查
+
+| 命令 | 作用 | 需要运行中的 Unity？ |
+|---|---|:---:|
+| `uco install <项目>` | 一次性接入运行时 | 否 |
+| `uco ping` | 探活 REST 桥 | 是 |
+| `uco list` | 列出可用工具 | 是 |
+| `uco call <工具> --args '{...}'` | 调用某个工具 | 是 |
+| `uco exec --code '<C# 代码>'` | 在编辑器内执行 C# 代码片段 | 是 |
+| `uco install-unity` | 安装 Unity 编辑器 / 官方 CLI | 否 |
+| `uco create-project <路径>` | 创建新 Unity 项目 | 否 |
+| `uco editors` | 查看已安装编辑器 | 否 |
+| `uco build <项目>` | 批量构建 | 否 |
+| `uco test <项目>` | 批量测试 | 否 |
+
+完整命令列表：`uco --help`；某条命令的详细选项：`uco <命令> --help`。
+
+## 6. 配合 AI 编程助手
+
+uco 的设计就是让 AI 调用。在项目里生成 AI skills 文件，注册到你的 agent（如 Claude Code），agent 即可通过 shell 命令驱动 Unity：
+
+```bash
+uco setup-skills "D:\YourUnityProject"
+```
+
+详见 `uco setup-skills --help`。
+
+## 7. 常见问题
+
+**`uco ping` 不通**
+
+- 确认 Unity 编辑器已打开该项目，且脚本编译已完成。
+- 端口与 token 存放在 `UserSettings/uco-config.json`；端口由项目路径确定性生成。务必在**项目目录**下运行 ping，或用 `--url` / `--token` 显式指定。
+
+**想接入另一个项目**
+直接对新项目再跑一次 `uco install <新项目>`，各项目互不影响。
+
+**卸载 uco**
+
+```bash
+npm uninstall -g uco
+```
+
+已用 embed 模式接入的 Unity 项目自带插件源副本，卸载 uco 不影响这些项目。
+
+## 8. 限制
+
+- **目标机需装有 Node.js 20+**：服务器以 Node 进程运行（编译后的 JS，非内嵌运行时）。
+- **NuGet DLL 为打包时的快照**：功能完整，但不一定包含最新源码改动。
+
+---
+
+*如遇本指南未覆盖的问题，请联系分发者。*

package/node_modules/chalk/license

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
+
+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/node_modules/chalk/package.json

@@ -0,0 +1,83 @@
+{
+	"name": "chalk",
+	"version": "5.6.2",
+	"description": "Terminal string styling done right",
+	"license": "MIT",
+	"repository": "chalk/chalk",
+	"funding": "https://github.com/chalk/chalk?sponsor=1",
+	"type": "module",
+	"main": "./source/index.js",
+	"exports": "./source/index.js",
+	"imports": {
+		"#ansi-styles": "./source/vendor/ansi-styles/index.js",
+		"#supports-color": {
+			"node": "./source/vendor/supports-color/index.js",
+			"default": "./source/vendor/supports-color/browser.js"
+		}
+	},
+	"types": "./source/index.d.ts",
+	"sideEffects": false,
+	"engines": {
+		"node": "^12.17.0 || ^14.13 || >=16.0.0"
+	},
+	"scripts": {
+		"test": "xo && c8 ava && tsd",
+		"bench": "matcha benchmark.js"
+	},
+	"files": [
+		"source",
+		"!source/index.test-d.ts"
+	],
+	"keywords": [
+		"color",
+		"colour",
+		"colors",
+		"terminal",
+		"console",
+		"cli",
+		"string",
+		"ansi",
+		"style",
+		"styles",
+		"tty",
+		"formatting",
+		"rgb",
+		"256",
+		"shell",
+		"xterm",
+		"log",
+		"logging",
+		"command-line",
+		"text"
+	],
+	"devDependencies": {
+		"@types/node": "^16.11.10",
+		"ava": "^3.15.0",
+		"c8": "^7.10.0",
+		"color-convert": "^2.0.1",
+		"execa": "^6.0.0",
+		"log-update": "^5.0.0",
+		"matcha": "^0.7.0",
+		"tsd": "^0.19.0",
+		"xo": "^0.57.0",
+		"yoctodelay": "^2.0.0"
+	},
+	"xo": {
+		"rules": {
+			"unicorn/prefer-string-slice": "off",
+			"@typescript-eslint/consistent-type-imports": "off",
+			"@typescript-eslint/consistent-type-exports": "off",
+			"@typescript-eslint/consistent-type-definitions": "off",
+			"unicorn/expiring-todo-comments": "off"
+		}
+	},
+	"c8": {
+		"reporter": [
+			"text",
+			"lcov"
+		],
+		"exclude": [
+			"source/vendor"
+		]
+	}
+}

package/node_modules/chalk/readme.md

@@ -0,0 +1,297 @@
+<h1 align="center">
+	<br>
+	<br>
+	<img width="320" src="media/logo.svg" alt="Chalk">
+	<br>
+	<br>
+	<br>
+</h1>
+
+> Terminal string styling done right
+
+[![Coverage Status](https://codecov.io/gh/chalk/chalk/branch/main/graph/badge.svg)](https://codecov.io/gh/chalk/chalk)
+[![npm dependents](https://badgen.net/npm/dependents/chalk)](https://www.npmjs.com/package/chalk?activeTab=dependents)
+[![Downloads](https://badgen.net/npm/dt/chalk)](https://www.npmjs.com/package/chalk)
+
+![](media/screenshot.png)
+
+## Info
+
+- [Why not switch to a smaller coloring package?](https://github.com/chalk/chalk?tab=readme-ov-file#why-not-switch-to-a-smaller-coloring-package)
+- See [yoctocolors](https://github.com/sindresorhus/yoctocolors) for a smaller alternative
+
+## Highlights
+
+- Expressive API
+- Highly performant
+- No dependencies
+- Ability to nest styles
+- [256/Truecolor color support](#256-and-truecolor-color-support)
+- Auto-detects color support
+- Doesn't extend `String.prototype`
+- Clean and focused
+- Actively maintained
+- [Used by ~115,000 packages](https://www.npmjs.com/browse/depended/chalk) as of July 4, 2024
+
+## Install
+
+```sh
+npm install chalk
+```
+
+**IMPORTANT:** Chalk 5 is ESM. If you want to use Chalk with TypeScript or a build tool, you will probably want to use Chalk 4 for now. [Read more.](https://github.com/chalk/chalk/releases/tag/v5.0.0)
+
+## Usage
+
+```js
+import chalk from 'chalk';
+
+console.log(chalk.blue('Hello world!'));
+```
+
+Chalk comes with an easy to use composable API where you just chain and nest the styles you want.
+
+```js
+import chalk from 'chalk';
+
+const log = console.log;
+
+// Combine styled and normal strings
+log(chalk.blue('Hello') + ' World' + chalk.red('!'));
+
+// Compose multiple styles using the chainable API
+log(chalk.blue.bgRed.bold('Hello world!'));
+
+// Pass in multiple arguments
+log(chalk.blue('Hello', 'World!', 'Foo', 'bar', 'biz', 'baz'));
+
+// Nest styles
+log(chalk.red('Hello', chalk.underline.bgBlue('world') + '!'));
+
+// Nest styles of the same type even (color, underline, background)
+log(chalk.green(
+	'I am a green line ' +
+	chalk.blue.underline.bold('with a blue substring') +
+	' that becomes green again!'
+));
+
+// ES2015 template literal
+log(`
+CPU: ${chalk.red('90%')}
+RAM: ${chalk.green('40%')}
+DISK: ${chalk.yellow('70%')}
+`);
+
+// Use RGB colors in terminal emulators that support it.
+log(chalk.rgb(123, 45, 67).underline('Underlined reddish color'));
+log(chalk.hex('#DEADED').bold('Bold gray!'));
+```
+
+Easily define your own themes:
+
+```js
+import chalk from 'chalk';
+
+const error = chalk.bold.red;
+const warning = chalk.hex('#FFA500'); // Orange color
+
+console.log(error('Error!'));
+console.log(warning('Warning!'));
+```
+
+Take advantage of console.log [string substitution](https://nodejs.org/docs/latest/api/console.html#console_console_log_data_args):
+
+```js
+import chalk from 'chalk';
+
+const name = 'Sindre';
+console.log(chalk.green('Hello %s'), name);
+//=> 'Hello Sindre'
+```
+
+## API
+
+### chalk.`<style>[.<style>...](string, [string...])`
+
+Example: `chalk.red.bold.underline('Hello', 'world');`
+
+Chain [styles](#styles) and call the last one as a method with a string argument. Order doesn't matter, and later styles take precedent in case of a conflict. This simply means that `chalk.red.yellow.green` is equivalent to `chalk.green`.
+
+Multiple arguments will be separated by space.
+
+### chalk.level
+
+Specifies the level of color support.
+
+Color support is automatically detected, but you can override it by setting the `level` property. You should however only do this in your own code as it applies globally to all Chalk consumers.
+
+If you need to change this in a reusable module, create a new instance:
+
+```js
+import {Chalk} from 'chalk';
+
+const customChalk = new Chalk({level: 0});
+```
+
+| Level | Description |
+| :---: | :--- |
+| `0` | All colors disabled |
+| `1` | Basic color support (16 colors) |
+| `2` | 256 color support |
+| `3` | Truecolor support (16 million colors) |
+
+### supportsColor
+
+Detect whether the terminal [supports color](https://github.com/chalk/supports-color). Used internally and handled for you, but exposed for convenience.
+
+Can be overridden by the user with the flags `--color` and `--no-color`. For situations where using `--color` is not possible, use the environment variable `FORCE_COLOR=1` (level 1), `FORCE_COLOR=2` (level 2), or `FORCE_COLOR=3` (level 3) to forcefully enable color, or `FORCE_COLOR=0` to forcefully disable. The use of `FORCE_COLOR` overrides all other color support checks.
+
+Explicit 256/Truecolor mode can be enabled using the `--color=256` and `--color=16m` flags, respectively.
+
+### chalkStderr and supportsColorStderr
+
+`chalkStderr` contains a separate instance configured with color support detected for `stderr` stream instead of `stdout`. Override rules from `supportsColor` apply to this too. `supportsColorStderr` is exposed for convenience.
+
+### modifierNames, foregroundColorNames, backgroundColorNames, and colorNames
+
+All supported style strings are exposed as an array of strings for convenience. `colorNames` is the combination of `foregroundColorNames` and `backgroundColorNames`.
+
+This can be useful if you wrap Chalk and need to validate input:
+
+```js
+import {modifierNames, foregroundColorNames} from 'chalk';
+
+console.log(modifierNames.includes('bold'));
+//=> true
+
+console.log(foregroundColorNames.includes('pink'));
+//=> false
+```
+
+## Styles
+
+### Modifiers
+
+- `reset` - Reset the current style.
+- `bold` - Make the text bold.
+- `dim` - Make the text have lower opacity.
+- `italic` - Make the text italic. *(Not widely supported)*
+- `underline` - Put a horizontal line below the text. *(Not widely supported)*
+- `overline` - Put a horizontal line above the text. *(Not widely supported)*
+- `inverse`- Invert background and foreground colors.
+- `hidden` - Print the text but make it invisible.
+- `strikethrough` - Puts a horizontal line through the center of the text. *(Not widely supported)*
+- `visible`- Print the text only when Chalk has a color level above zero. Can be useful for things that are purely cosmetic.
+
+### Colors
+
+- `black`
+- `red`
+- `green`
+- `yellow`
+- `blue`
+- `magenta`
+- `cyan`
+- `white`
+- `blackBright` (alias: `gray`, `grey`)
+- `redBright`
+- `greenBright`
+- `yellowBright`
+- `blueBright`
+- `magentaBright`
+- `cyanBright`
+- `whiteBright`
+
+### Background colors
+
+- `bgBlack`
+- `bgRed`
+- `bgGreen`
+- `bgYellow`
+- `bgBlue`
+- `bgMagenta`
+- `bgCyan`
+- `bgWhite`
+- `bgBlackBright` (alias: `bgGray`, `bgGrey`)
+- `bgRedBright`
+- `bgGreenBright`
+- `bgYellowBright`
+- `bgBlueBright`
+- `bgMagentaBright`
+- `bgCyanBright`
+- `bgWhiteBright`
+
+## 256 and Truecolor color support
+
+Chalk supports 256 colors and [Truecolor](https://github.com/termstandard/colors) (16 million colors) on supported terminal apps.
+
+Colors are downsampled from 16 million RGB values to an ANSI color format that is supported by the terminal emulator (or by specifying `{level: n}` as a Chalk option). For example, Chalk configured to run at level 1 (basic color support) will downsample an RGB value of #FF0000 (red) to 31 (ANSI escape for red).
+
+Examples:
+
+- `chalk.hex('#DEADED').underline('Hello, world!')`
+- `chalk.rgb(15, 100, 204).inverse('Hello!')`
+
+Background versions of these models are prefixed with `bg` and the first level of the module capitalized (e.g. `hex` for foreground colors and `bgHex` for background colors).
+
+- `chalk.bgHex('#DEADED').underline('Hello, world!')`
+- `chalk.bgRgb(15, 100, 204).inverse('Hello!')`
+
+The following color models can be used:
+
+- [`rgb`](https://en.wikipedia.org/wiki/RGB_color_model) - Example: `chalk.rgb(255, 136, 0).bold('Orange!')`
+- [`hex`](https://en.wikipedia.org/wiki/Web_colors#Hex_triplet) - Example: `chalk.hex('#FF8800').bold('Orange!')`
+- [`ansi256`](https://en.wikipedia.org/wiki/ANSI_escape_code#8-bit) - Example: `chalk.bgAnsi256(194)('Honeydew, more or less')`
+
+## Browser support
+
+Since Chrome 69, ANSI escape codes are natively supported in the developer console.
+
+## Windows
+
+If you're on Windows, do yourself a favor and use [Windows Terminal](https://github.com/microsoft/terminal) instead of `cmd.exe`.
+
+## FAQ
+
+### Why not switch to a smaller coloring package?
+
+Chalk may be larger, but there is a reason for that. It offers a more user-friendly API, well-documented types, supports millions of colors, and covers edge cases that smaller alternatives miss. Chalk is mature, reliable, and built to last.
+
+But beyond the technical aspects, there's something more critical: trust and long-term maintenance. I have been active in open source for over a decade, and I'm committed to keeping Chalk maintained. Smaller packages might seem appealing now, but there's no guarantee they will be around for the long term, or that they won't become malicious over time.
+
+Chalk is also likely already in your dependency tree (since 100K+ packages depend on it), so switching won’t save space—in fact, it might increase it. npm deduplicates dependencies, so multiple Chalk instances turn into one, but adding another package alongside it will increase your overall size.
+
+If the goal is to clean up the ecosystem, switching away from Chalk won’t even make a dent. The real problem lies with packages that have very deep dependency trees (for example, those including a lot of polyfills). Chalk has no dependencies. It's better to focus on impactful changes rather than minor optimizations.
+
+If absolute package size is important to you, I also maintain [yoctocolors](https://github.com/sindresorhus/yoctocolors), one of the smallest color packages out there.
+
+*\- [Sindre](https://github.com/sindresorhus)*
+
+### But the smaller coloring package has benchmarks showing it is faster
+
+[Micro-benchmarks are flawed](https://sindresorhus.com/blog/micro-benchmark-fallacy) because they measure performance in unrealistic, isolated scenarios, often giving a distorted view of real-world performance. Don't believe marketing fluff. All the coloring packages are more than fast enough.
+
+## Related
+
+- [chalk-template](https://github.com/chalk/chalk-template) - [Tagged template literals](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals#tagged_templates) support for this module
+- [chalk-cli](https://github.com/chalk/chalk-cli) - CLI for this module
+- [ansi-styles](https://github.com/chalk/ansi-styles) - ANSI escape codes for styling strings in the terminal
+- [supports-color](https://github.com/chalk/supports-color) - Detect whether a terminal supports color
+- [strip-ansi](https://github.com/chalk/strip-ansi) - Strip ANSI escape codes
+- [strip-ansi-stream](https://github.com/chalk/strip-ansi-stream) - Strip ANSI escape codes from a stream
+- [has-ansi](https://github.com/chalk/has-ansi) - Check if a string has ANSI escape codes
+- [ansi-regex](https://github.com/chalk/ansi-regex) - Regular expression for matching ANSI escape codes
+- [wrap-ansi](https://github.com/chalk/wrap-ansi) - Wordwrap a string with ANSI escape codes
+- [slice-ansi](https://github.com/chalk/slice-ansi) - Slice a string with ANSI escape codes
+- [color-convert](https://github.com/qix-/color-convert) - Converts colors between different models
+- [chalk-animation](https://github.com/bokub/chalk-animation) - Animate strings in the terminal
+- [gradient-string](https://github.com/bokub/gradient-string) - Apply color gradients to strings
+- [chalk-pipe](https://github.com/LitoMore/chalk-pipe) - Create chalk style schemes with simpler style strings
+- [terminal-link](https://github.com/sindresorhus/terminal-link) - Create clickable links in the terminal
+
+*(Not accepting additional entries)*
+
+## Maintainers
+
+- [Sindre Sorhus](https://github.com/sindresorhus)
+- [Josh Junon](https://github.com/qix-)