Skip to content

docs(web): clarify tui plugin logging #32502

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
hcsum wants to merge 2 commits into
base: dev
Choose a base branch
from
+9 −1
Open

docs(web): clarify tui plugin logging #32502

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6b748fb
docs(web): clarify tui plugin logging
hcsum Jun 16, 2026
41ed9e5
docs(web): keep english-only plugin logging note
hcsum Jun 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion packages/web/src/content/docs/plugins.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,14 +105,22 @@ export const MyPlugin = async (ctx) => {

```js title=".opencode/plugins/example.js"
export const MyPlugin = async ({ project, client, $, directory, worktree }) => {
console.log("Plugin initialized!")
await client.app.log({
body: {
service: "my-plugin",
level: "info",
message: "Plugin initialized",
},
})

return {
// Hook implementations go here
}
}
```

For TUI plugins, avoid `console.log()` and `console.error()`. They write to the same terminal session as the client UI and can disrupt the input area. Prefer `client.app.log()` instead.

The plugin function receives:

- `project`: The current project information.
Expand Down
Loading