القائمة
Guides creation of Zhin plugins with lifecycle hooks, auto-loading, and hot-reload behavior. Use when developers need plugin structure, lifecycle events, or reloading details.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
Explains Zhin command registration, middleware flow, and permission checks. Use when building commands or message middleware in Zhin plugins.
Guides creation and management of Zhin tools using ZhinTool, defineTool, and ToolService. Covers the unified tool system that bridges AI agent tool-calling and message commands, including Tool↔Command conversion, permission levels, platform/scope filtering, and tool collection. Use when registering tools, converting between tools and commands, or integrating tools with AI agents.
Guides integration of AI/LLM capabilities in Zhin plugins using @zhin.js/ai. Covers multi-model providers, Agent tool calling, session management, streaming responses, unified tool services, and rich media output. Use when adding AI chat, agents, or tool-calling features to a Zhin bot.
Guides development of custom platform adapters in Zhin. Covers extending the Adapter abstract class, creating Bot instances, handling message events, registering tools, and lifecycle management. Use when building adapters for new chat platforms.
Guides database usage in Zhin including model definitions, CRUD queries, transactions, migrations, and lifecycle hooks. Covers the built-in ORM based on @zhin.js/database with SQLite support. Use when working with data persistence in Zhin plugins.
Guides error handling in Zhin using the built-in error hierarchy, ErrorManager, RetryManager, and CircuitBreaker. Use when implementing resilient error handling, retry logic, or circuit breaker patterns in Zhin plugins.
| name | zhin-plugin-lifecycle |
| description | Guides creation of Zhin plugins with lifecycle hooks, auto-loading, and hot-reload behavior. Use when developers need plugin structure, lifecycle events, or reloading details. |
| license | MIT |
| metadata | {"author":"zhinjs","version":"1.0","framework":"zhin"} |
Use this skill to help developers scaffold and reason about Zhin plugins, including lifecycle hooks, auto-loading behavior, and hot-reload interactions.
Start with the minimal plugin entry file that uses usePlugin() so Zhin can create a plugin instance for the file:
import { usePlugin } from '@zhin.js/core'
const plugin = usePlugin()
plugin.onMounted(() => {
plugin.logger.info(`Plugin ${plugin.name} mounted`)
})
plugin.onDispose(() => {
plugin.logger.info(`Plugin ${plugin.name} disposed`)
})
usePlugin() creates (and registers) the plugin instance based on the current file path.plugin.onMounted runs after contexts are mounted and child plugins start.plugin.onDispose runs when the plugin is stopped or reloaded.In development mode (NODE_ENV=development), the core will watch plugin files and trigger reloads when they change.
plugin.onMounted(() => {
plugin.logger.debug('Plugin ready for HMR')
})
plugin.reload().plugin.stop().mounted lifecycle events fire again.If the plugin is the root plugin, reload exits the process (exit code 51) so the CLI can restart it.
Use plugin.import() to load child plugins relative to the current file:
await plugin.import('./sub-plugin/index.ts')
Notes:
plugin.features returns registered commands, components, crons, and middleware names.plugin.info() returns a nested tree of features for the plugin and its children.Use this to build "health" commands for debugging plugin loads.
usePlugin() once.onDispose to clean up timers or external connections.plugin.import() for dependent plugins.plugin.onMounted for deferred setup once contexts are ready.