tinker-agent 1.0.65 → 1.2.0

package/CHANGELOG.md

@@ -0,0 +1,36 @@
+# Changelog
+
+All notable user-facing changes to Tinker are documented here. The project follows
+[Semantic Versioning](https://semver.org/).
+
+## [Unreleased]
+
+## [1.2.0] - 2026-07-21
+
+### Added
+
+- Ship Bun 1.3.14 as an npm dependency and launch it through the installed `tinker`
+  command, so users no longer need a system-wide Bun installation.
+- Ship a verified platform-specific ripgrep binary for Grep and workspace file
+  discovery instead of requiring a system-wide `rg` installation.
+- License the project under Apache License 2.0 and preserve the original Infinite
+  Context architecture attribution in `NOTICE`.
+- Add CI, release-package verification, community health files, and an npm trusted
+  publishing workflow with provenance.
+
+### Changed
+
+- Require Node.js 20 or later for the npm-installed launcher.
+- Limit npm package contents to runtime source, license and attribution material,
+  and required bundled dependencies.
+
+## [1.1.0] - 2026-07-21
+
+### Added
+
+- First formal npm release under the `tinker-agent` package name with the `tinker`
+  executable.
+
+[Unreleased]: https://github.com/ishowshao/tinker/compare/v1.2.0...HEAD
+[1.2.0]: https://github.com/ishowshao/tinker/releases/tag/v1.2.0
+[1.1.0]: https://www.npmjs.com/package/tinker-agent/v/1.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 ishowshao
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,6 @@
+Tinker
+Copyright 2026 ishowshao
+
+The original Tinker Infinite Context architecture and its initial
+implementation were designed and developed by ishowshao as part of the
+Tinker project: https://github.com/ishowshao/tinker

package/README.md

@@ -16,41 +16,75 @@ Built with [Bun](https://bun.sh) + TypeScript ESM, powered by [Ink](https://gith
   - `WebSearch` — Search the web via Exa API
   - `WebFetch` — Fetch and refine web page content (local, browser, or Exa backend)
   - `Recall` — Search or retrieve model-visible history from the current session
+- **Agent Skills**: Discover compatible `SKILL.md` packages at project and user
+  scope, disclose their catalog progressively, and keep activated instructions
+  durable across context compaction and session resume.
 - **MCP integration**: Connect external [Model Context Protocol](https://modelcontextprotocol.io) servers — their tools are dynamically registered as `mcp__<server>__<tool>`.
 - **Session persistence**: Sessions are persisted via SQLite, supporting session resume, history recall, and a catalog to browse and switch between sessions.
 - **Observation system**: Tool execution results are formatted into structured text that the model sees, with separate raw results for event logs and TUI display.
 - **Turn cancellation**: Users can cancel an ongoing turn safely, with protocol-safe synthetic tool messages.
 - **Context metering**: Budget-aware context management with protocol validation before sending requests to the model.
 - **Deterministic context compaction**: Idle sessions can swap eligible historical tool output into Recall-addressable placeholders without calling the model.
+- **Infinite Context architecture**: Immutable canonical history, deterministic
+  context revisions, Recall-addressable cold state, and qualified prefix retirement
+  keep long-running sessions recoverable without pretending the model has infinite
+  tokens. See the [technical design](docs/infinite-context-technical-design-a.md).
 - **Choice of models**: Supports any OpenAI-compatible API (defaults to DeepSeek). Configurable via environment variables.
 
 ## Quick Start
 
 ```bash
-# Clone and install
-git clone <repo>
-cd tinker
-bun install
+npm install --global tinker-agent
 
 # Start the interactive TUI
-bun run tinker
+tinker
 
 # Run a one-shot prompt
-bun run tinker run "explain the project structure"
+tinker run "explain the project structure"
 ```
 
+The npm package includes its own Bun runtime. To run Tinker from a source checkout,
+install Bun 1.3 or later, then use `bun install` followed by `bun run tinker`.
+
 ### Slash Commands
 
 - `/view <path>` — Open a readable UTF-8 text file in a full-window viewer. Relative
   paths must remain inside the workspace; absolute paths may point outside it. Use
   the keyboard or mouse wheel to scroll and press `Esc` to close the viewer.
+- `/copy` — Copy the current session's last completed assistant response to the
+  system clipboard as raw Markdown.
 - `/status` — Show session and context details.
-- `/compact` — Deterministically compact eligible historical tool output while the session is idle.
+- `/skills` — Show available skills, their scope and active state, plus user skills
+  shadowed by a project skill.
+- `/compact` — Deterministically compact eligible historical tool output while the
+  session is idle.
+- `/compact retire` — Retire a complete cold history prefix from the active request;
+  the original history remains available through `Recall`.
 - `/model [profile-name]` — Choose a model profile for a new session.
 - `/resume [session-id]` — Choose or directly resume a stored session.
 - `/session delete <session-id> --confirm` — Delete a stored session.
 - `/quit` — Exit the TUI.
 
+### Agent Skills
+
+Tinker scans `<workspace>/.agents/skills/` and `~/.agents/skills/` once when a new
+or resumed runtime starts. Each direct child skill must contain a strictly valid
+`SKILL.md`; an invalid discovered skill stops activation with a clear error. A
+project skill wins when both scopes define the same name.
+
+Only skill names and descriptions are initially exposed to the model. When the
+model selects a matching skill through the conditional `Skill` tool, Tinker sends
+the complete snapshotted `SKILL.md` and a bounded listing of its standard resource
+directories. Relative resource paths are resolved from that skill's directory and
+are read or executed only through Tinker's existing tools. Activated instructions
+remain in the current system surface across later turns and compaction; resume
+rebinds them to the current validated files.
+
+Skill content is not local-only after activation: it is sent to the configured
+model provider and persisted in the private session SQLite database, event log,
+and observation log, just like other model-visible file content. `/skills` is
+read-only and does not rescan, install, activate, or remove skills.
+
 ## Configuration
 
 Tinker is configured via environment variables:
@@ -117,6 +151,33 @@ longer present or its runtime contract has changed. Older sessions without a
 stored profile name can resume only when their model name uniquely matches one
 configured profile.
 
+### Project Custom Slash Commands
+
+The TUI loads optional project-scoped prompt aliases from `.tinker.json` in the
+workspace root:
+
+```json
+{
+  "version": 1,
+  "slashCommands": [
+    {
+      "name": "git-commit-and-push",
+      "description": "Commit and push workspace changes",
+      "prompt": "Please inspect the workspace changes, create an appropriate commit, and push it."
+    }
+  ]
+}
+```
+
+Enter `/git-commit-and-push` to submit its configured prompt as an ordinary user
+turn. Built-in slash commands appear first in suggestions, followed by project
+commands in configuration order. Custom commands accept no arguments and cannot
+override built-ins. The optional configuration is loaded once at TUI startup,
+must be valid when present, and has a 1 MiB size limit. It is not loaded by the
+one-shot `tinker run` command. See
+[`docs/project-custom-slash-commands-design.md`](docs/project-custom-slash-commands-design.md)
+for the full contract.
+
 `Read` has a fixed 262144-byte (256 KiB) content limit per call. A successful
 call always returns the complete requested line range. Use `offset` and `limit`
 to page through larger files; oversized requests fail instead of returning
@@ -146,6 +207,7 @@ tinker/
 │   ├── model/         # Model clients (OpenAI-compatible, fake), chat mapping, preflight
 │   ├── mcp/           # MCP server management, tool executor adapter
 │   ├── observation/   # Tool result → model-visible text
+│   ├── skills/        # Agent Skills discovery, catalog, activation, and context
 │   ├── session/       # SQLite session store, catalog, history reader, resume
 │   ├── events/        # Event sinks, JSONL log, stdout printer
 │   ├── tui/           # Ink/React UI components, projection store, session controller
@@ -165,9 +227,28 @@ tinker/
 
 ## Requirements
 
-- [Bun](https://bun.sh) (developed with Bun 1.x)
+- Node.js 20 or later and npm for the global package installation
+- [Bun](https://bun.sh) 1.3 or later for development from source
 - A compatible LLM API (defaults to DeepSeek; any OpenAI-compatible API works)
 
+## Security
+
+Tinker is an agent with permission to read and modify files and run shell commands in
+the selected workspace. Review its configuration and model-provider data policies
+before using it with sensitive source code. Please report vulnerabilities privately
+through [GitHub Security Advisories](https://github.com/ishowshao/tinker/security/advisories/new).
+
+## Contributing
+
+Contributions are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for the development
+workflow and [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) for community expectations.
+
+## Attribution
+
+The original Tinker Infinite Context architecture and its initial implementation were
+designed and developed by **ishowshao**. See [NOTICE](NOTICE) for the attribution that
+accompanies distributions and derivative works.
+
 ## License
 
-MIT
+Licensed under the [Apache License 2.0](LICENSE).

package/bin/tinker.js

@@ -0,0 +1,39 @@
+#!/usr/bin/env node
+
+import { spawnSync } from "node:child_process";
+import { createRequire } from "node:module";
+import { dirname, join } from "node:path";
+import { fileURLToPath } from "node:url";
+
+const require = createRequire(import.meta.url);
+
+let bunPackageJson;
+try {
+  bunPackageJson = require.resolve("bun/package.json");
+} catch {
+  process.stderr.write(
+    "Tinker could not find its bundled Bun runtime. Reinstall tinker-agent.\n",
+  );
+  process.exit(1);
+}
+
+const bunExecutable = join(dirname(bunPackageJson), "bin", "bun.exe");
+const tinkerEntryPoint = fileURLToPath(
+  new URL("../src/cli/index.ts", import.meta.url),
+);
+const result = spawnSync(
+  bunExecutable,
+  [tinkerEntryPoint, ...process.argv.slice(2)],
+  { stdio: "inherit" },
+);
+
+if (result.error !== undefined) {
+  process.stderr.write(`Tinker failed to start Bun: ${result.error.message}\n`);
+  process.exit(1);
+}
+
+if (result.signal !== null) {
+  process.kill(process.pid, result.signal);
+}
+
+process.exit(result.status ?? 1);

package/node_modules/ansi-regex/index.d.ts

@@ -0,0 +1,33 @@
+export type Options = {
+	/**
+	Match only the first ANSI escape.
+
+	@default false
+	*/
+	readonly onlyFirst: boolean;
+};
+
+/**
+Regular expression for matching ANSI escape codes.
+
+@example
+```
+import ansiRegex from 'ansi-regex';
+
+ansiRegex().test('\u001B[4mcake\u001B[0m');
+//=> true
+
+ansiRegex().test('cake');
+//=> false
+
+'\u001B[4mcake\u001B[0m'.match(ansiRegex());
+//=> ['\u001B[4m', '\u001B[0m']
+
+'\u001B[4mcake\u001B[0m'.match(ansiRegex({onlyFirst: true}));
+//=> ['\u001B[4m']
+
+'\u001B]8;;https://github.com\u0007click\u001B]8;;\u0007'.match(ansiRegex());
+//=> ['\u001B]8;;https://github.com\u0007', '\u001B]8;;\u0007']
+```
+*/
+export default function ansiRegex(options?: Options): RegExp;

package/node_modules/ansi-regex/index.js

@@ -0,0 +1,14 @@
+export default function ansiRegex({onlyFirst = false} = {}) {
+	// Valid string terminator sequences are BEL, ESC\, and 0x9c
+	const ST = '(?:\\u0007|\\u001B\\u005C|\\u009C)';
+
+	// OSC sequences only: ESC ] ... ST (non-greedy until the first ST)
+	const osc = `(?:\\u001B\\][\\s\\S]*?${ST})`;
+
+	// CSI and related: ESC/C1, optional intermediates, optional params (supports ; and :) then final byte
+	const csi = '[\\u001B\\u009B][[\\]()#;?]*(?:\\d{1,4}(?:[;:]\\d{0,4})*)?[\\dA-PR-TZcf-nq-uy=><~]';
+
+	const pattern = `${osc}|${csi}`;
+
+	return new RegExp(pattern, onlyFirst ? undefined : 'g');
+}

package/node_modules/ansi-regex/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/ansi-regex/package.json

@@ -0,0 +1,61 @@
+{
+	"name": "ansi-regex",
+	"version": "6.2.2",
+	"description": "Regular expression for matching ANSI escape codes",
+	"license": "MIT",
+	"repository": "chalk/ansi-regex",
+	"funding": "https://github.com/chalk/ansi-regex?sponsor=1",
+	"author": {
+		"name": "Sindre Sorhus",
+		"email": "sindresorhus@gmail.com",
+		"url": "https://sindresorhus.com"
+	},
+	"type": "module",
+	"exports": "./index.js",
+	"types": "./index.d.ts",
+	"sideEffects": false,
+	"engines": {
+		"node": ">=12"
+	},
+	"scripts": {
+		"test": "xo && ava && tsd",
+		"view-supported": "node fixtures/view-codes.js"
+	},
+	"files": [
+		"index.js",
+		"index.d.ts"
+	],
+	"keywords": [
+		"ansi",
+		"styles",
+		"color",
+		"colour",
+		"colors",
+		"terminal",
+		"console",
+		"cli",
+		"string",
+		"tty",
+		"escape",
+		"formatting",
+		"rgb",
+		"256",
+		"shell",
+		"xterm",
+		"command-line",
+		"text",
+		"regex",
+		"regexp",
+		"re",
+		"match",
+		"test",
+		"find",
+		"pattern"
+	],
+	"devDependencies": {
+		"ansi-escapes": "^5.0.0",
+		"ava": "^3.15.0",
+		"tsd": "^0.21.0",
+		"xo": "^0.54.2"
+	}
+}

package/node_modules/ansi-regex/readme.md

@@ -0,0 +1,66 @@
+# ansi-regex
+
+> Regular expression for matching [ANSI escape codes](https://en.wikipedia.org/wiki/ANSI_escape_code)
+
+## Install
+
+```sh
+npm install ansi-regex
+```
+
+## Usage
+
+```js
+import ansiRegex from 'ansi-regex';
+
+ansiRegex().test('\u001B[4mcake\u001B[0m');
+//=> true
+
+ansiRegex().test('cake');
+//=> false
+
+'\u001B[4mcake\u001B[0m'.match(ansiRegex());
+//=> ['\u001B[4m', '\u001B[0m']
+
+'\u001B[4mcake\u001B[0m'.match(ansiRegex({onlyFirst: true}));
+//=> ['\u001B[4m']
+
+'\u001B]8;;https://github.com\u0007click\u001B]8;;\u0007'.match(ansiRegex());
+//=> ['\u001B]8;;https://github.com\u0007', '\u001B]8;;\u0007']
+```
+
+## API
+
+### ansiRegex(options?)
+
+Returns a regex for matching ANSI escape codes.
+
+#### options
+
+Type: `object`
+
+##### onlyFirst
+
+Type: `boolean`\
+Default: `false` *(Matches any ANSI escape codes in a string)*
+
+Match only the first ANSI escape.
+
+## Important
+
+If you run the regex against untrusted user input in a server context, you should [give it a timeout](https://github.com/sindresorhus/super-regex).
+
+**I do not consider [ReDoS](https://blog.yossarian.net/2022/12/28/ReDoS-vulnerabilities-and-misaligned-incentives) a valid vulnerability for this package.**
+
+## FAQ
+
+### Why do you test for codes not in the ECMA 48 standard?
+
+Some of the codes we run as a test are codes that we acquired finding various lists of non-standard or manufacturer specific codes. We test for both standard and non-standard codes, as most of them follow the same or similar format and can be safely matched in strings without the risk of removing actual string content. There are a few non-standard control codes that do not follow the traditional format (i.e. they end in numbers) thus forcing us to exclude them from the test because we cannot reliably match them.
+
+On the historical side, those ECMA standards were established in the early 90's whereas the VT100, for example, was designed in the mid/late 70's. At that point in time, control codes were still pretty ungoverned and engineers used them for a multitude of things, namely to activate hardware ports that may have been proprietary. Somewhere else you see a similar 'anarchy' of codes is in the x86 architecture for processors; there are a ton of "interrupts" that can mean different things on certain brands of processors, most of which have been phased out.
+
+## Maintainers
+
+- [Sindre Sorhus](https://github.com/sindresorhus)
+- [Josh Junon](https://github.com/qix-)