@ampcode/plugin 0.0.0-20260502002909-g5fc25db → 0.0.0-20260504002927-gb6f16b2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/index.d.ts +4 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Amp Plugin API
|
|
4
4
|
|
|
5
|
-
Amp plugins are TypeScript files that extend and customize [Amp](https://ampcode.com). Plugins live in `.amp/plugins/` (project) or `~/.config/amp/plugins/` (
|
|
5
|
+
Amp plugins are TypeScript files that extend and customize [Amp](https://ampcode.com). Plugins live in `.amp/plugins/` (project) or `~/.config/amp/plugins/` (system).
|
|
6
6
|
|
|
7
7
|
> The Amp plugin API is experimental. Expect many breaking changes if you choose to use it right now. Do not use it for anything critical.
|
|
8
8
|
|
package/index.d.ts
CHANGED
|
@@ -5,7 +5,7 @@ declare module '@ampcode/plugin' {
|
|
|
5
5
|
* Plugins are JavaScript/TypeScript programs that extend & customize Amp.
|
|
6
6
|
* They are long-lived processes that may run for multiple threads concurrently.
|
|
7
7
|
*
|
|
8
|
-
* Plugins live in `.amp/plugins/` (project) or `~/.config/amp/plugins/` (
|
|
8
|
+
* Plugins live in `.amp/plugins/` (project) or `~/.config/amp/plugins/` (system) and are executed using Bun.
|
|
9
9
|
*
|
|
10
10
|
* A plugin exports a default function that receives a {@link PluginAPI} instance. For example:
|
|
11
11
|
*
|
|
@@ -766,6 +766,9 @@ declare module '@ampcode/plugin' {
|
|
|
766
766
|
* Context passed to tool execute handlers.
|
|
767
767
|
*/
|
|
768
768
|
export interface PluginToolContext {
|
|
769
|
+
/** UI capabilities provided to plugins */
|
|
770
|
+
ui: PluginUI
|
|
771
|
+
|
|
769
772
|
/** Scoped logger for plugin output */
|
|
770
773
|
logger: PluginLogger
|
|
771
774
|
}
|