mirror of
https://github.com/mark3labs/kit.git
synced 2026-06-14 03:30:26 +00:00
ezynda3
131 lines
3.3 KiB
HTML
131 lines
3.3 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<title>Loading Extensions | Kit</title>
|
|
<meta name="description" content="How Kit discovers and loads extensions.">
|
|
<link rel="canonical" href="/extensions/loading">
|
|
<link rel="stylesheet" href="/assets/index-Di_r5hA0.css">
|
|
<script type="module" src="/assets/index-BbQ_p9l4.js"></script>
|
|
<script type="application/ld+json">{"@context":"https://schema.org","@type":"TechArticle","headline":"Loading Extensions","description":"How Kit discovers and loads extensions.","url":"https://go-kit.dev/extensions/loading","isPartOf":{"@type":"WebSite","name":"Kit","url":"https://go-kit.dev"}}</script>
|
|
</head>
|
|
<body>
|
|
<div id="tome-root"></div>
|
|
<div data-pagefind-body style="display:none"><h1>Loading Extensions</h1>
|
|
# Loading Extensions
|
|
|
|
## Auto-discovery
|
|
|
|
Kit automatically discovers and loads extensions from these paths, in order:
|
|
|
|
| Path | Scope |
|
|
|------|-------|
|
|
| `~/.config/kit/extensions/*.go` | Global single files |
|
|
| `~/.config/kit/extensions/*/main.go` | Global subdirectory extensions |
|
|
| `.kit/extensions/*.go` | Project-local single files |
|
|
| `.kit/extensions/*/main.go` | Project-local subdirectory extensions |
|
|
| `~/.local/share/kit/git/` | Global git-installed packages |
|
|
| `.kit/git/` | Project-local git-installed packages |
|
|
|
|
## Explicit loading
|
|
|
|
Load extensions by path using the `-e` flag:
|
|
|
|
```bash
|
|
kit -e path/to/extension.go
|
|
```
|
|
|
|
Load multiple extensions:
|
|
|
|
```bash
|
|
kit -e ext1.go -e ext2.go
|
|
```
|
|
|
|
## Disabling extensions
|
|
|
|
Disable all auto-discovered extensions:
|
|
|
|
```bash
|
|
kit --no-extensions
|
|
```
|
|
|
|
You can combine `--no-extensions` with `-e` to load only specific extensions:
|
|
|
|
```bash
|
|
kit --no-extensions -e my-extension.go
|
|
```
|
|
|
|
## Installing from git
|
|
|
|
Install extensions from git repositories using `kit install`:
|
|
|
|
```bash
|
|
# Install globally (to ~/.local/share/kit/git/)
|
|
kit install https://github.com/user/my-kit-extension.git
|
|
|
|
# Install project-locally (to .kit/git/)
|
|
kit install -l https://github.com/user/my-kit-extension.git
|
|
|
|
# Update an installed package
|
|
kit install -u https://github.com/user/my-kit-extension.git
|
|
|
|
# Remove
|
|
kit install --uninstall my-kit-extension
|
|
```
|
|
|
|
## Extension structure
|
|
|
|
### Single-file extensions
|
|
|
|
A single `.go` file with an `Init` function:
|
|
|
|
```go
|
|
//go:build ignore
|
|
|
|
package main
|
|
|
|
import "kit/ext"
|
|
|
|
func Init(api ext.API) {
|
|
// register handlers, tools, commands, etc.
|
|
}
|
|
```
|
|
|
|
The `//go:build ignore` directive prevents the Go toolchain from trying to compile the file as part of a normal build.
|
|
|
|
### Subdirectory extensions
|
|
|
|
For more complex extensions, create a directory with a `main.go` entry point:
|
|
|
|
```
|
|
.kit/extensions/my-extension/
|
|
├── main.go # Must contain Init(api ext.API)
|
|
├── helpers.go # Additional source files
|
|
└── config.go
|
|
```
|
|
|
|
### Package-level state
|
|
|
|
Yaegi supports package-level variables captured in closures. This is the standard way to maintain state across event callbacks:
|
|
|
|
```go
|
|
package main
|
|
|
|
import "kit/ext"
|
|
|
|
var callCount int
|
|
|
|
func Init(api ext.API) {
|
|
api.OnToolCall(func(_ ext.ToolCallEvent, ctx ext.Context) {
|
|
callCount++
|
|
ctx.SetFooter(ext.HeaderFooterConfig{
|
|
Content: ext.WidgetContent{
|
|
Text: fmt.Sprintf("Tools called: %d", callCount),
|
|
},
|
|
})
|
|
})
|
|
}
|
|
```</div>
|
|
</body>
|
|
</html> |