chore(docs): i18n sync (#15417)
This commit is contained in:
@@ -3,7 +3,7 @@ title: 플러그인
|
||||
description: OpenCode를 확장하기 위해 자신만의 플러그인을 작성하세요.
|
||||
---
|
||||
|
||||
플러그인은 다양한 이벤트와 사용자 정의 행동으로 후킹하여 opencode를 확장 할 수 있습니다. 플러그인을 만들 수 있습니다 새로운 기능을 추가, 외부 서비스와 통합, 또는 opencode의 기본 동작을 수정.
|
||||
플러그인은 다양한 이벤트와 사용자 정의 행동으로 후킹하여 opencode를 확장 할 수 있습니다. 플러그인을 사용하여 새로운 기능을 추가하거나, 외부 서비스와 통합하거나, opencode의 기본 동작을 수정할 수 있습니다.
|
||||
|
||||
예를 들어, 커뮤니티에 의해 생성 된 [plugins](/docs/ecosystem#plugins)를 확인하십시오.
|
||||
|
||||
@@ -11,18 +11,18 @@ description: OpenCode를 확장하기 위해 자신만의 플러그인을 작성
|
||||
|
||||
## 플러그인 사용
|
||||
|
||||
플러그인을로드하는 두 가지 방법이 있습니다.
|
||||
플러그인을 로드하는 두 가지 방법이 있습니다.
|
||||
|
||||
---
|
||||
|
||||
## 로컬 파일에서
|
||||
### 로컬 파일에서
|
||||
|
||||
플러그인 디렉토리에 JavaScript 또는 TypeScript 파일을 배치합니다.
|
||||
|
||||
- `.opencode/plugins/` - 프로젝트 레벨 플러그인
|
||||
- `~/.config/opencode/plugins/` - 글로벌 플러그인
|
||||
|
||||
이 디렉토리의 파일은 자동으로 시작에로드됩니다.
|
||||
이 디렉토리의 파일은 시작 시 자동으로 로드됩니다.
|
||||
|
||||
---
|
||||
|
||||
@@ -37,43 +37,42 @@ config 파일에 npm 패키지를 지정합니다.
|
||||
}
|
||||
```
|
||||
|
||||
일반 및 범위의 npm 패키지 모두 지원됩니다.
|
||||
일반 패키지 및 스코프 npm 패키지 모두 지원됩니다.
|
||||
|
||||
[ecosystem](/docs/ecosystem#plugins)에서 사용할 수 있는 플러그인을 찾아보세요.
|
||||
|
||||
---
|
||||
|
||||
## 플러그인이 설치되는 방법
|
||||
### 플러그인이 설치되는 방법
|
||||
|
||||
**npm 플러그인**은 시작시 Bun을 사용하여 자동으로 설치됩니다. 패키지와 그들의 의존성은 `~/.cache/opencode/node_modules/`에서 캐시됩니다.
|
||||
**npm 플러그인**은 시작시 Bun을 사용하여 자동으로 설치됩니다. 패키지와 그 의존성은 `~/.cache/opencode/node_modules/`에 캐시됩니다.
|
||||
|
||||
**로컬 플러그인**은 플러그인 디렉토리에서 직접로드됩니다. 외부 패키지를 사용하려면 구성 디렉토리 내 `package.json`를 작성해야 합니다 ([Dependencies](#dependencies)), 또는 플러그인을 npm에 게시하고 [config에 추가](/docs/config#plugins).
|
||||
**로컬 플러그인**은 플러그인 디렉토리에서 직접 로드됩니다. 외부 패키지를 사용하려면 구성 디렉토리 내에 `package.json`을 작성해야 하거나([의존성](#의존성) 참조), 플러그인을 npm에 게시하고 [config에 추가](/docs/config#plugins)해야 합니다.
|
||||
|
||||
---
|
||||
|
||||
## 로드 순서
|
||||
### 로드 순서
|
||||
|
||||
플러그인은 모든 소스에서로드되며 모든 후크는 순서대로 실행됩니다. 로드 순서는 다음과 같습니다:
|
||||
플러그인은 모든 소스에서 로드되며 모든 후크는 순서대로 실행됩니다. 로드 순서는 다음과 같습니다:
|
||||
|
||||
1. 글로벌 구성 (`~/.config/opencode/opencode.json`)
|
||||
2. 프로젝트 구성 (`opencode.json`)
|
||||
3. 글로벌 플러그인 디렉토리 (`~/.config/opencode/plugins/`)
|
||||
4. 프로젝트 플러그인 디렉토리 (`.opencode/plugins/`)
|
||||
|
||||
중복 npm 패키지는 한 번만 로드됩니다. 하지만, 로컬 플러그인과 같은 이름과 npm 플러그인은 모두 별도로로드됩니다.
|
||||
중복된 이름과 버전의 npm 패키지는 한 번만 로드됩니다. 하지만 로컬 플러그인과 npm 플러그인의 이름이 비슷하더라도 둘 다 별도로 로드됩니다.
|
||||
|
||||
---
|
||||
|
||||
## 플러그인 만들기
|
||||
|
||||
플러그인은 **JavaScript/TypeScript 모듈**입니다.
|
||||
기능. 각 함수는 context 객체를 수신하고 Hooks 객체를 반환합니다.
|
||||
플러그인은 하나 이상의 플러그인 함수를 내보내는 **JavaScript/TypeScript 모듈**입니다. 각 함수는 context 객체를 수신하고 hooks 객체를 반환합니다.
|
||||
|
||||
---
|
||||
|
||||
### 의존성
|
||||
|
||||
로컬 플러그인 및 사용자 정의 도구는 외부 npm 패키지를 사용할 수 있습니다. `package.json`를 config 디렉토리에 추가하면 필요한 의존도가 있습니다.
|
||||
로컬 플러그인 및 사용자 정의 도구는 외부 npm 패키지를 사용할 수 있습니다. config 디렉토리에 `package.json`을 추가하고 필요한 의존성을 명시하십시오.
|
||||
|
||||
```json title=".opencode/package.json"
|
||||
{
|
||||
@@ -83,7 +82,7 @@ config 파일에 npm 패키지를 지정합니다.
|
||||
}
|
||||
```
|
||||
|
||||
opencode는 `bun install`를 시작합니다. 플러그인 및 도구가 가져올 수 있습니다.
|
||||
opencode는 시작 시 `bun install`을 실행하여 이를 설치합니다. 이후 플러그인 및 도구에서 가져올 수 있습니다.
|
||||
|
||||
```ts title=".opencode/plugins/my-plugin.ts"
|
||||
import { escape } from "shescape"
|
||||
@@ -113,19 +112,19 @@ export const MyPlugin = async ({ project, client, $, directory, worktree }) => {
|
||||
}
|
||||
```
|
||||
|
||||
플러그인 기능 수신:
|
||||
플러그인 함수가 받는 인자:
|
||||
|
||||
- `project`: 현재 프로젝트 정보.
|
||||
- `directory`: 현재 작업 디렉토리.
|
||||
- `worktree`: git worktree 경로.
|
||||
- `client`: AI와 상호 작용을 위한 opencode SDK 클라이언트.
|
||||
- `$`: Bun's [shell API](https://bun.com/docs/runtime/shell) 명령어를 실행합니다.
|
||||
- `$`: 명령어를 실행하기 위한 Bun의 [shell API](https://bun.com/docs/runtime/shell).
|
||||
|
||||
---
|
||||
|
||||
### TypeScript 지원
|
||||
|
||||
TypeScript 플러그인의 경우 플러그인 패키지에서 유형을 가져올 수 있습니다.
|
||||
TypeScript 플러그인의 경우 플러그인 패키지에서 타입을 가져올 수 있습니다.
|
||||
|
||||
```ts title="my-plugin.ts" {1}
|
||||
import type { Plugin } from "@opencode-ai/plugin"
|
||||
@@ -139,29 +138,29 @@ export const MyPlugin: Plugin = async ({ project, client, $, directory, worktree
|
||||
|
||||
---
|
||||
|
||||
## 이벤트
|
||||
### 이벤트
|
||||
|
||||
플러그인은 예제 섹션에서 아래에서 볼 때 이벤트에 가입 할 수 있습니다. 여기에 다른 이벤트의 목록입니다.
|
||||
플러그인은 아래 예제 섹션에서 볼 수 있듯이 이벤트를 구독할 수 있습니다. 사용 가능한 이벤트 목록은 다음과 같습니다.
|
||||
|
||||
### 명령어 이벤트
|
||||
#### 명령어 이벤트
|
||||
|
||||
- `command.executed`
|
||||
|
||||
### 파일 이벤트
|
||||
#### 파일 이벤트
|
||||
|
||||
- `file.edited`
|
||||
- `file.watcher.updated`
|
||||
|
||||
### 설치 이벤트
|
||||
#### 설치 이벤트
|
||||
|
||||
- `installation.updated`
|
||||
|
||||
### LSP 이벤트
|
||||
#### LSP 이벤트
|
||||
|
||||
- `lsp.client.diagnostics`
|
||||
- `lsp.updated`
|
||||
|
||||
### 메시지 이벤트
|
||||
#### 메시지 이벤트
|
||||
|
||||
- `message.part.removed`
|
||||
- `message.part.updated`
|
||||
@@ -173,11 +172,11 @@ export const MyPlugin: Plugin = async ({ project, client, $, directory, worktree
|
||||
- `permission.asked`
|
||||
- `permission.replied`
|
||||
|
||||
### 서버 이벤트
|
||||
#### 서버 이벤트
|
||||
|
||||
- `server.connected`
|
||||
|
||||
### 세션 이벤트
|
||||
#### 세션 이벤트
|
||||
|
||||
- `session.created`
|
||||
- `session.compacted`
|
||||
@@ -188,7 +187,7 @@ export const MyPlugin: Plugin = async ({ project, client, $, directory, worktree
|
||||
- `session.status`
|
||||
- `session.updated`
|
||||
|
||||
### Todo 이벤트
|
||||
#### Todo 이벤트
|
||||
|
||||
- `todo.updated`
|
||||
|
||||
@@ -196,7 +195,7 @@ export const MyPlugin: Plugin = async ({ project, client, $, directory, worktree
|
||||
|
||||
- `shell.env`
|
||||
|
||||
##### 도구 이벤트
|
||||
#### 도구 이벤트
|
||||
|
||||
- `tool.execute.after`
|
||||
- `tool.execute.before`
|
||||
@@ -211,11 +210,11 @@ export const MyPlugin: Plugin = async ({ project, client, $, directory, worktree
|
||||
|
||||
## 예제
|
||||
|
||||
opencode를 확장하기 위해 사용할 수있는 플러그인의 몇 가지 예입니다.
|
||||
opencode를 확장하기 위해 사용할 수 있는 플러그인 예제입니다.
|
||||
|
||||
---
|
||||
|
||||
## 알림 보내기
|
||||
### 알림 보내기
|
||||
|
||||
특정 이벤트가 발생할 때 알림을 전송:
|
||||
|
||||
@@ -232,7 +231,7 @@ export const NotificationPlugin = async ({ project, client, $, directory, worktr
|
||||
}
|
||||
```
|
||||
|
||||
macOS에서 AppleScript를 실행하려면 `osascript`를 사용하고 있습니다. 여기에 우리는 그것을 사용하여 알림을 보낼 수 있습니다.
|
||||
macOS에서 AppleScript를 실행하기 위해 `osascript`를 사용하고 있습니다. 여기서는 알림을 보내는 데 사용합니다.
|
||||
|
||||
:::note
|
||||
opencode 데스크톱 앱을 사용하는 경우 응답이 준비되어 있거나 세션 오류가 있을 때 시스템 알림을 자동으로 보낼 수 있습니다.
|
||||
@@ -242,7 +241,7 @@ opencode 데스크톱 앱을 사용하는 경우 응답이 준비되어 있거
|
||||
|
||||
### .env 보호
|
||||
|
||||
읽기 `.env` 파일에서 opencode를 방지하십시오:
|
||||
opencode가 `.env` 파일을 읽지 못하도록 방지:
|
||||
|
||||
```javascript title=".opencode/plugins/env-protection.js"
|
||||
export const EnvProtection = async ({ project, client, $, directory, worktree }) => {
|
||||
@@ -260,7 +259,7 @@ export const EnvProtection = async ({ project, client, $, directory, worktree })
|
||||
|
||||
### Inject 환경 변수
|
||||
|
||||
환경 변수를 모든 shell 실행 (AI 도구 및 사용자 terminal)로 주사하십시오.
|
||||
모든 shell 실행(AI 도구 및 사용자 terminal)에 환경 변수 주입:
|
||||
|
||||
```javascript title=".opencode/plugins/inject-env.js"
|
||||
export const InjectEnvPlugin = async () => {
|
||||
@@ -277,7 +276,7 @@ export const InjectEnvPlugin = async () => {
|
||||
|
||||
### 사용자 정의 도구
|
||||
|
||||
플러그인은 opencode에 사용자 정의 도구를 추가 할 수 있습니다 :
|
||||
플러그인은 opencode에 사용자 정의 도구를 추가할 수 있습니다:
|
||||
|
||||
```ts title=".opencode/plugins/custom-tools.ts"
|
||||
import { type Plugin, tool } from "@opencode-ai/plugin"
|
||||
@@ -300,13 +299,17 @@ export const CustomToolsPlugin: Plugin = async (ctx) => {
|
||||
}
|
||||
```
|
||||
|
||||
`tool` helper는 opencode가 호출 할 수있는 사용자 정의 도구를 만듭니다. Zod schema 기능을 가지고 도구 정의를 반환:
|
||||
`tool` helper는 opencode가 호출할 수 있는 사용자 정의 도구를 만듭니다. Zod 스키마 함수를 받고 다음을 포함하는 도구 정의를 반환합니다:
|
||||
|
||||
- `description`: 도구는 무엇을
|
||||
- `description`: 도구가 하는 일
|
||||
- `args`: 도구의 인수에 대한 Zod 스키마
|
||||
- `execute`: 도구가 호출될 때 실행되는 기능
|
||||
- `execute`: 도구가 호출될 때 실행되는 함수
|
||||
|
||||
사용자 정의 도구는 내장 도구와 함께 opencode를 사용할 수 있습니다.
|
||||
사용자 정의 도구는 내장 도구와 함께 opencode에서 사용할 수 있습니다.
|
||||
|
||||
:::note
|
||||
플러그인 도구가 내장 도구와 같은 이름을 사용하면 플러그인 도구가 우선순위를 갖습니다.
|
||||
:::
|
||||
|
||||
---
|
||||
|
||||
@@ -331,9 +334,9 @@ export const MyPlugin = async ({ client }) => {
|
||||
|
||||
---
|
||||
|
||||
## Compaction 훅
|
||||
### Compaction 훅
|
||||
|
||||
세션이 압축 될 때 포함 된 컨텍스트를 사용자 지정:
|
||||
세션이 압축될 때 포함되는 컨텍스트를 사용자 지정할 수 있습니다:
|
||||
|
||||
```ts title=".opencode/plugins/compaction.ts"
|
||||
import type { Plugin } from "@opencode-ai/plugin"
|
||||
@@ -355,9 +358,9 @@ Include any state that should persist across compaction:
|
||||
}
|
||||
```
|
||||
|
||||
LLM이 압축 요약을 생성하기 전에 `experimental.session.compacting` 훅이 실행됩니다. 기본 압축 프롬프트를 대체할 수 있도록 도메인 별 컨텍스트를 주입합니다.
|
||||
`experimental.session.compacting` 훅은 LLM이 연속 요약을 생성하기 전에 실행됩니다. 기본 압축 프롬프트가 놓칠 수 있는 도메인별 컨텍스트를 주입하는 데 사용하세요.
|
||||
|
||||
당신은 또한 `output.prompt`를 조정해서 조밀함을 전적으로 대체할 수 있습니다:
|
||||
또한 `output.prompt`를 설정하여 압축 프롬프트를 완전히 대체할 수도 있습니다:
|
||||
|
||||
```ts title=".opencode/plugins/custom-compaction.ts"
|
||||
import type { Plugin } from "@opencode-ai/plugin"
|
||||
@@ -382,4 +385,4 @@ Format as a structured prompt that a new agent can use to resume work.
|
||||
}
|
||||
```
|
||||
|
||||
`output.prompt`가 설정되면 완전히 기본 압축 프롬프트를 대체합니다. `output.context` 배열은 이 경우에 무시됩니다.
|
||||
`output.prompt`가 설정되면 기본 압축 프롬프트를 완전히 대체합니다. 이 경우 `output.context` 배열은 무시됩니다.
|
||||
|
||||
Reference in New Issue
Block a user