Przejdź do głównej treści

Documentation Index

Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

SDK Plugin jest udostępniany jako zestaw wąskich publicznych podścieżek w openclaw/plugin-sdk/. Ta strona kataloguje często używane podścieżki pogrupowane według celu. Wygenerowany inwentarz punktów wejścia kompilatora znajduje się w scripts/lib/plugin-sdk-entrypoints.json; eksporty pakietu to publiczny podzbiór po odjęciu lokalnych dla repozytorium podścieżek testowych/wewnętrznych wymienionych w scripts/lib/plugin-sdk-private-local-only-subpaths.json. Opiekunowie mogą audytować liczbę publicznych eksportów za pomocą pnpm plugin-sdk:surface oraz aktywne zarezerwowane podścieżki pomocnicze za pomocą pnpm plugins:boundary-report:summary; nieużywane zarezerwowane eksporty pomocnicze powodują niepowodzenie raportu CI zamiast pozostawać w publicznym SDK jako uśpiony dług zgodności. Przewodnik po tworzeniu Plugin znajdziesz w omówieniu SDK Plugin.

​
Punkt wejścia Plugin

PodścieżkaKluczowe eksporty
plugin-sdk/plugin-entrydefinePluginEntry
plugin-sdk/coredefineChannelPluginEntry, createChatChannelPlugin, createChannelPluginBase, defineSetupPluginEntry, buildChannelConfigSchema, buildJsonChannelConfigSchema
plugin-sdk/config-schemaOpenClawSchema
plugin-sdk/provider-entrydefineSingleProviderPluginEntry
plugin-sdk/migrationPomocnicze elementy dostawcy migracji, takie jak createMigrationItem, stałe przyczyn, znaczniki statusu elementów, pomocniki redakcji oraz summarizeMigrationItems
plugin-sdk/migration-runtimePomocniki migracji w czasie wykonywania, takie jak copyMigrationFileItem, withCachedMigrationConfigRuntime oraz writeMigrationReport

​
Przestarzała zgodność i pomocniki testowe

Te podścieżki pozostają eksportami pakietu dla starszych Plugin i zestawów testowych OpenClaw, ale nowy kod nie powinien dodawać importów z nich: agent-runtime-test-contracts, channel-contract-testing, channel-target-testing, channel-test-helpers, plugin-test-api, plugin-test-contracts, provider-http-test-mocks, provider-test-contracts, test-env, test-fixtures, test-node-mocks, testing, channel-runtime, compat, config-types, infra-runtime, text-runtime oraz zod. W nowym kodzie Plugin importuj zod bezpośrednio z zod. plugin-test-runtime nadal jest aktywną, wyspecjalizowaną podścieżką pomocnika testowego.

​
Przestarzałe nieużywane publiczne podścieżki

Te publiczne podścieżki istniały przez co najmniej miesiąc i obecnie nie mają produkcyjnych importów z dołączonych rozszerzeń. Pozostają importowalne ze względu na zgodność, ale nowy kod Plugin powinien zamiast nich używać wyspecjalizowanych, aktywnie używanych podścieżek SDK: agent-config-primitives, channel-config-schema-legacy, channel-reply-pipeline, channel-runtime, channel-secret-runtime, command-auth, compat, config-runtime, config-schema, discord, group-access, infra-runtime, matrix, mattermost, media-generation-runtime-shared, memory-core-engine-runtime, memory-core-host-multimodal, memory-core-host-query, music-generation-core, self-hosted-provider-setup, telegram-account, telegram-command-config oraz zalouser.

​
Przestarzałe rzadkie publiczne podścieżki

Publiczne podścieżki używane obecnie tylko przez jednego lub dwóch właścicieli dołączonych Plugin również są przestarzałe dla nowego kodu Plugin. Pozostają eksportami pakietu ze względu na zgodność, ale nowy kod powinien preferować aktywnie współdzielone punkty styku SDK albo należące do Plugin API pakietów. Opiekunowie śledzą dokładny zestaw w scripts/lib/plugin-sdk-deprecated-public-subpaths.json oraz bieżący budżet za pomocą pnpm plugin-sdk:surface.

​
Przestarzałe szerokie baryłki

Te szerokie baryłki reeksportów pozostają możliwe do zbudowania dla źródeł OpenClaw i kontroli zgodności, ale nowy kod powinien preferować wyspecjalizowane podścieżki SDK: agent-runtime, channel-lifecycle, channel-runtime, cli-runtime, compat, config-types, conversation-runtime, hook-runtime, infra-runtime, media-runtime, plugin-runtime, security-runtime oraz text-runtime. channel-runtime, compat, config-types, infra-runtime oraz text-runtime pozostają eksportami pakietu wyłącznie dla zgodności wstecznej; zamiast nich używaj wyspecjalizowanych podścieżek kanałów/czasu wykonywania, config-contracts, string-coerce-runtime, text-chunking, text-utility-runtime oraz logging-core.
PodścieżkaKluczowe eksporty
plugin-sdk/channel-coredefineChannelPluginEntry, defineSetupPluginEntry, createChatChannelPlugin, createChannelPluginBase
plugin-sdk/config-schemaEksport głównego schematu Zod openclaw.json (OpenClawSchema)
plugin-sdk/json-schema-runtimeBuforowany pomocnik walidacji JSON Schema dla schematów należących do wtyczki
plugin-sdk/channel-setupcreateOptionalChannelSetupSurface, createOptionalChannelSetupAdapter, createOptionalChannelSetupWizard, plus DEFAULT_ACCOUNT_ID, createTopLevelChannelDmPolicy, setSetupChannelEnabled, splitSetupEntries
plugin-sdk/setupWspółdzielone pomocniki kreatora konfiguracji, monity listy dozwolonych, konstruktory statusu konfiguracji
plugin-sdk/setup-runtimecreatePatchedAccountSetupAdapter, createEnvPatchedAccountSetupAdapter, createSetupInputPresenceValidator, noteChannelLookupFailure, noteChannelLookupSummary, promptResolvedAllowFrom, splitSetupEntries, createAllowlistSetupWizardProxy, createDelegatedSetupWizardProxy
plugin-sdk/setup-adapter-runtimePrzestarzały alias zgodności; użyj plugin-sdk/setup-runtime
plugin-sdk/setup-toolsformatCliCommand, detectBinary, extractArchive, resolveBrewExecutable, formatDocsLink, CONFIG_DIR
plugin-sdk/account-corePomocniki konfiguracji wielu kont/bramki akcji, pomocniki awaryjnego konta domyślnego
plugin-sdk/account-idDEFAULT_ACCOUNT_ID, pomocniki normalizacji identyfikatora konta
plugin-sdk/account-resolutionPomocniki wyszukiwania konta i awaryjnego użycia wartości domyślnej
plugin-sdk/account-helpersWąskie pomocniki listy kont/akcji konta
plugin-sdk/access-groupsPomocniki parsowania listy dozwolonych grup dostępu i zredagowanej diagnostyki grup
plugin-sdk/channel-pairingcreateChannelPairingController
plugin-sdk/channel-reply-pipelinePomocniki starszego potoku odpowiedzi. Nowy kod potoku odpowiedzi kanału powinien używać createChannelMessageReplyPipeline i resolveChannelMessageSourceReplyDeliveryMode z plugin-sdk/channel-message.
plugin-sdk/channel-config-helperscreateHybridChannelConfigAdapter, resolveChannelDmAccess, resolveChannelDmAllowFrom, resolveChannelDmPolicy, normalizeChannelDmPolicy, normalizeLegacyDmAliases
plugin-sdk/channel-config-schemaWspółdzielone prymitywy schematu konfiguracji kanału oraz konstruktory Zod i bezpośrednie konstruktory JSON/TypeBox
plugin-sdk/bundled-channel-config-schemaDołączone schematy konfiguracji kanałów OpenClaw tylko dla utrzymywanych dołączonych wtyczek
plugin-sdk/channel-config-schema-legacyPrzestarzały alias zgodności dla schematów konfiguracji dołączonych kanałów
plugin-sdk/telegram-command-configPomocniki normalizacji/walidacji niestandardowych poleceń Telegram z awaryjnym użyciem dołączonego kontraktu
plugin-sdk/command-gatingWąskie pomocniki bramki autoryzacji poleceń
plugin-sdk/channel-policyresolveChannelGroupRequireMention
plugin-sdk/channel-ingressPrzestarzała fasada zgodności niskopoziomowego wejścia kanału. Nowe ścieżki odbioru powinny używać plugin-sdk/channel-ingress-runtime.
plugin-sdk/channel-ingress-runtimeEksperymentalny, wysokopoziomowy resolver środowiska wykonawczego wejścia kanału i konstruktory faktów trasy dla zmigrowanych ścieżek odbioru kanału. Preferuj to zamiast składania efektywnych list dozwolonych, list dozwolonych poleceń i starszych projekcji w każdej wtyczce. Zobacz API wejścia kanału.
plugin-sdk/channel-lifecyclecreateAccountStatusSink, createChannelRunQueue i starsze pomocniki cyklu życia strumienia wersji roboczej. Nowy kod finalizacji podglądu powinien używać plugin-sdk/channel-message.
plugin-sdk/channel-messageTanie pomocniki kontraktu cyklu życia wiadomości, takie jak defineChannelMessageAdapter, createChannelMessageAdapterFromOutbound, createChannelMessageReplyPipeline, createReplyPrefixContext, resolveChannelMessageSourceReplyDeliveryMode, wyprowadzanie możliwości trwałej finalizacji, pomocniki dowodów możliwości wysyłania/odbioru/efektów ubocznych, MessageReceiveContext, dowody zasad potwierdzania odbioru, defineFinalizableLivePreviewAdapter, deliverWithFinalizableLivePreviewAdapter, dowody możliwości podglądu na żywo i finalizatora na żywo, trwały stan odzyskiwania, RenderedMessageBatch, typy potwierdzeń wiadomości i pomocniki identyfikatorów potwierdzeń. Zobacz API wiadomości kanału. Starsze fasady rozsyłania odpowiedzi są tylko przestarzałą zgodnością.
plugin-sdk/channel-message-runtimePomocniki dostarczania środowiska wykonawczego, które mogą ładować dostarczanie wychodzące, w tym deliverInboundReplyWithMessageSendContext, sendDurableMessageBatch i withDurableMessageSendContext. Przestarzałe mosty rozsyłania odpowiedzi pozostają importowalne tylko dla dyspozytorów zgodności. Używaj z modułów środowiska wykonawczego monitorowania/wysyłania, nie z gorących plików startowych wtyczki.
plugin-sdk/inbound-envelopeWspółdzielone pomocniki trasy przychodzącej i konstruktora koperty
plugin-sdk/inbound-reply-dispatchStarsze współdzielone pomocniki rejestrowania i rozsyłania rekordów przychodzących, predykaty widocznego/finalnego rozsyłania oraz przestarzała zgodność deliverDurableInboundReplyPayload dla przygotowanych dyspozytorów kanałów. Nowy kod odbioru/rozsyłania kanału powinien importować pomocniki cyklu życia środowiska wykonawczego z plugin-sdk/channel-message-runtime.
plugin-sdk/messaging-targetsPomocniki parsowania/dopasowywania celów
plugin-sdk/outbound-mediaWspółdzielone pomocniki ładowania multimediów wychodzących
plugin-sdk/outbound-send-depsLekkie wyszukiwanie zależności wysyłania wychodzącego dla adapterów kanału
plugin-sdk/outbound-runtimePomocniki tożsamości wychodzącej, delegata wysyłania, sesji, formatowania i planowania ładunku. Bezpośrednie pomocniki dostarczania, takie jak deliverOutboundPayloads, są przestarzałą warstwą zgodności; używaj plugin-sdk/channel-message-runtime dla nowych ścieżek wysyłania.
plugin-sdk/poll-runtimeWąskie pomocniki normalizacji ankiet
plugin-sdk/thread-bindings-runtimePomocniki cyklu życia wiązań wątku i adapterów
plugin-sdk/agent-media-payloadStarszy konstruktor ładunku multimediów agenta
plugin-sdk/conversation-runtimePomocniki wiązania rozmowy/wątku, parowania i skonfigurowanego wiązania
plugin-sdk/runtime-config-snapshotPomocnik migawki konfiguracji środowiska wykonawczego
plugin-sdk/runtime-group-policyPomocniki rozwiązywania zasad grup środowiska wykonawczego
plugin-sdk/channel-statusWspółdzielone pomocniki migawki/podsumowania statusu kanału
plugin-sdk/channel-config-primitivesWąskie prymitywy schematu konfiguracji kanału
plugin-sdk/channel-config-writesPomocniki autoryzacji zapisu konfiguracji kanału
plugin-sdk/channel-plugin-commonWspółdzielone eksporty wstępu wtyczki kanału
plugin-sdk/allowlist-config-editPomocniki edycji/odczytu konfiguracji listy dozwolonych
plugin-sdk/group-accessWspółdzielone pomocniki decyzji dostępu grupowego
plugin-sdk/direct-dmWspółdzielone pomocniki uwierzytelniania/ochrony bezpośrednich wiadomości DM
plugin-sdk/discordPrzestarzała fasada zgodności Discord dla opublikowanego @openclaw/discord@2026.3.13 i śledzonej zgodności właściciela; nowe wtyczki powinny używać ogólnych podścieżek SDK kanału
plugin-sdk/telegram-accountPrzestarzała fasada zgodności rozwiązywania kont Telegram dla śledzonej zgodności właściciela; nowe wtyczki powinny używać wstrzykniętych pomocników środowiska wykonawczego albo ogólnych podścieżek SDK kanału
plugin-sdk/zalouserPrzestarzała fasada zgodności Zalo Personal dla opublikowanych pakietów Lark/Zalo, które nadal importują autoryzację poleceń nadawcy; nowe wtyczki powinny używać plugin-sdk/command-auth
plugin-sdk/interactive-runtimeSemantyczna prezentacja wiadomości, dostarczanie i starsze pomocniki interaktywnych odpowiedzi. Zobacz Prezentacja wiadomości
plugin-sdk/channel-inboundBarrel zgodności dla odbijania wejścia, dopasowywania wzmianek, pomocników zasad wzmianek i pomocników kopert
plugin-sdk/channel-inbound-debounceWąskie pomocniki odbijania wejścia
plugin-sdk/channel-mention-gatingWąskie pomocniki zasad wzmianek, znaczników wzmianek i tekstu wzmianek bez szerszej powierzchni środowiska wykonawczego wejścia
plugin-sdk/channel-envelopeWąskie pomocniki formatowania koperty przychodzącej
plugin-sdk/channel-locationKontekst lokalizacji kanału i pomocniki formatowania
plugin-sdk/channel-loggingPomocniki logowania kanału dla odrzuceń przychodzących i niepowodzeń wpisywania/potwierdzania
plugin-sdk/channel-send-resultTypy wyniku odpowiedzi
plugin-sdk/channel-actionsPomocniki akcji wiadomości kanału oraz przestarzałe pomocniki schematów natywnych zachowane dla zgodności wtyczek
plugin-sdk/channel-routeWspółdzielona normalizacja trasy, rozwiązywanie celów sterowane parserem, konwersja identyfikatora wątku na ciąg, deduplikacja/kompaktowanie kluczy trasy, typy sparsowanych celów i pomocniki porównywania trasy/celu
plugin-sdk/channel-targetsPomocniki parsowania celów; wywołujący porównanie tras powinni używać plugin-sdk/channel-route
plugin-sdk/channel-contractTypy kontraktu kanału
plugin-sdk/channel-feedbackOkablowanie opinii/reakcji
plugin-sdk/channel-secret-runtimeWąskie pomocniki kontraktu sekretów, takie jak collectSimpleChannelFieldAssignments, getChannelSurface, pushAssignment i typy celów sekretów
PodścieżkaKluczowe eksporty
plugin-sdk/provider-entrydefineSingleProviderPluginEntry
plugin-sdk/lmstudioObsługiwana fasada dostawcy LM Studio do konfiguracji, wykrywania katalogu i przygotowywania modelu w czasie działania
plugin-sdk/lmstudio-runtimeObsługiwana fasada czasu działania LM Studio dla lokalnych ustawień domyślnych serwera, wykrywania modeli, nagłówków żądań i helperów wczytanych modeli
plugin-sdk/provider-setupWyselekcjonowane helpery konfiguracji lokalnych/samodzielnie hostowanych dostawców
plugin-sdk/self-hosted-provider-setupWyspecjalizowane helpery konfiguracji samodzielnie hostowanych dostawców zgodnych z OpenAI
plugin-sdk/cli-backendDomyślne ustawienia backendu CLI + stałe watchdoga
plugin-sdk/provider-auth-runtimeHelpery rozwiązywania kluczy API w czasie działania dla pluginów dostawców
plugin-sdk/provider-auth-api-keyHelpery onboardingu kluczy API/zapisu profilu, takie jak upsertApiKeyProfile
plugin-sdk/provider-auth-resultStandardowy builder wyniku uwierzytelniania OAuth
plugin-sdk/provider-env-varsHelpery wyszukiwania zmiennych środowiskowych uwierzytelniania dostawcy
plugin-sdk/provider-authcreateProviderApiKeyAuthMethod, ensureApiKeyFromOptionEnvOrPrompt, upsertAuthProfile, upsertApiKeyProfile, writeOAuthCredentials, przestarzały eksport zgodności resolveOpenClawAgentDir
plugin-sdk/provider-model-sharedProviderReplayFamily, buildProviderReplayFamilyHooks, normalizeModelCompat, współdzielone buildery zasad odtwarzania, helpery punktów końcowych dostawcy oraz współdzielone helpery normalizacji identyfikatorów modeli
plugin-sdk/provider-catalog-runtimeHook czasu działania rozszerzania katalogu dostawcy i szwy rejestru plugin-dostawca do testów kontraktu
plugin-sdk/provider-catalog-sharedfindCatalogTemplate, buildSingleProviderApiKeyCatalog, buildManifestModelProviderConfig, supportsNativeStreamingUsageCompat, applyProviderNativeStreamingUsageCompat
plugin-sdk/provider-httpOgólne helpery możliwości HTTP/punktów końcowych dostawcy, błędy HTTP dostawcy i helpery formularzy multipart do transkrypcji audio
plugin-sdk/provider-web-fetch-contractWąskie helpery kontraktu konfiguracji/wyboru web-fetch, takie jak enablePluginInConfig i WebFetchProviderPlugin
plugin-sdk/provider-web-fetchHelpery rejestracji/pamięci podręcznej dostawcy web-fetch
plugin-sdk/provider-web-search-config-contractWąskie helpery konfiguracji/poświadczeń wyszukiwania w sieci dla dostawców, którzy nie potrzebują okablowania włączania pluginu
plugin-sdk/provider-web-search-contractWąskie helpery kontraktu konfiguracji/poświadczeń wyszukiwania w sieci, takie jak createWebSearchProviderContractFields, enablePluginInConfig, resolveProviderWebSearchPluginConfig oraz zakresowe settery/gettery poświadczeń
plugin-sdk/provider-web-searchHelpery rejestracji/pamięci podręcznej/czasu działania dostawcy wyszukiwania w sieci
plugin-sdk/provider-toolsProviderToolCompatFamily, buildProviderToolCompatFamilyHooks oraz czyszczenie schematów Gemini + diagnostyka
plugin-sdk/provider-usagefetchClaudeUsage i podobne
plugin-sdk/provider-streamProviderStreamFamily, buildProviderStreamFamilyHooks, composeProviderStreamWrappers, typy wrapperów strumienia oraz współdzielone helpery wrapperów Anthropic/Bedrock/DeepSeek V4/Google/Kilocode/Moonshot/OpenAI/OpenRouter/Z.A.I/MiniMax/Copilot
plugin-sdk/provider-transport-runtimeNatywne helpery transportu dostawcy, takie jak chronione fetch, transformacje komunikatów transportu i zapisywalne strumienie zdarzeń transportu
plugin-sdk/provider-onboardHelpery łatek konfiguracji onboardingu
plugin-sdk/global-singletonHelpery singletonów/map/pamięci podręcznej lokalnych dla procesu
plugin-sdk/group-activationWąskie helpery trybu aktywacji grupy i parsowania poleceń
PodścieżkaKluczowe eksporty
plugin-sdk/command-authresolveControlCommandGate, helpery rejestru poleceń, w tym formatowanie dynamicznego menu argumentów, helpery autoryzacji nadawcy
plugin-sdk/command-statusBuildery komunikatów poleceń/pomocy, takie jak buildCommandsMessagePaginated i buildHelpMessage
plugin-sdk/approval-auth-runtimeHelpery rozwiązywania zatwierdzających i uwierzytelniania akcji w tym samym czacie
plugin-sdk/approval-client-runtimeNatywne helpery profilu/filtra zatwierdzania exec
plugin-sdk/approval-delivery-runtimeNatywne adaptery możliwości/dostarczania zatwierdzeń
plugin-sdk/approval-gateway-runtimeWspółdzielony helper rozwiązywania Gateway zatwierdzeń
plugin-sdk/approval-handler-adapter-runtimeLekkie helpery ładowania natywnych adapterów zatwierdzeń dla gorących punktów wejścia kanałów
plugin-sdk/approval-handler-runtimeSzersze helpery czasu działania obsługi zatwierdzeń; preferuj węższe szwy adaptera/Gateway, gdy wystarczą
plugin-sdk/approval-native-runtimeNatywne helpery celu zatwierdzenia + powiązania konta
plugin-sdk/approval-reply-runtimeHelpery ładunku odpowiedzi zatwierdzenia exec/pluginu
plugin-sdk/approval-runtimeHelpery ładunku zatwierdzenia exec/pluginu, natywne helpery routingu/czasu działania zatwierdzeń oraz helpery uporządkowanego wyświetlania zatwierdzeń, takie jak formatApprovalDisplayPath
plugin-sdk/reply-dedupeWąskie helpery resetowania deduplikacji odpowiedzi przychodzących
plugin-sdk/channel-contract-testingWąskie helpery testów kontraktu kanału bez szerokiej beczki testowej
plugin-sdk/command-auth-nativeNatywne uwierzytelnianie poleceń, formatowanie dynamicznego menu argumentów i natywne helpery celu sesji
plugin-sdk/command-detectionWspółdzielone helpery wykrywania poleceń
plugin-sdk/command-primitives-runtimeLekkie predykaty tekstu poleceń dla gorących ścieżek kanałów
plugin-sdk/command-surfaceNormalizacja treści polecenia i helpery powierzchni poleceń
plugin-sdk/allow-fromformatAllowFromLowercase
plugin-sdk/channel-secret-runtimeWąskie helpery zbierania kontraktu sekretów dla powierzchni sekretów kanału/pluginu
plugin-sdk/secret-ref-runtimeWąskie helpery typowania coerceSecretRef i SecretRef do parsowania kontraktu sekretów/konfiguracji
plugin-sdk/security-runtimeWspółdzielone helpery zaufania, bramkowania DM, plików/ścieżek ograniczonych do katalogu głównego, w tym zapisy tylko tworzące, synchroniczna/asynchroniczna atomowa wymiana plików, zapisy do sąsiednich plików tymczasowych, awaryjne przenoszenie między urządzeniami, helpery prywatnego magazynu plików, zabezpieczenia rodziców symlinków, treści zewnętrzne, redakcja wrażliwego tekstu, porównywanie sekretów w stałym czasie i helpery zbierania sekretów
plugin-sdk/ssrf-policyHelpery listy dozwolonych hostów i polityki SSRF sieci prywatnej
plugin-sdk/ssrf-dispatcherWąskie helpery przypiętego dispatchera bez szerokiej powierzchni czasu działania infrastruktury
plugin-sdk/ssrf-runtimePrzypięty dispatcher, fetch chroniony przed SSRF, błąd SSRF i helpery polityki SSRF
plugin-sdk/secret-inputHelpery parsowania wejścia sekretu
plugin-sdk/webhook-ingressHelpery żądań/celów Webhooka i koercja surowego websocket/body
plugin-sdk/webhook-request-guardsHelpery rozmiaru/limitu czasu treści żądania
Ścieżka podrzędnaGłówne eksporty
plugin-sdk/runtimeSzerokie helpery środowiska uruchomieniowego, logowania, kopii zapasowych i instalacji pluginów
plugin-sdk/runtime-envWąskie helpery środowiska uruchomieniowego, rejestratora, limitów czasu, ponawiania prób i opóźnień wykładniczych
plugin-sdk/browser-configObsługiwana fasada konfiguracji przeglądarki do znormalizowanego profilu/wartości domyślnych, parsowania adresu URL CDP i helperów uwierzytelniania sterowania przeglądarką
plugin-sdk/channel-runtime-contextGeneryczne helpery rejestracji i wyszukiwania kontekstu środowiska uruchomieniowego kanału
plugin-sdk/matrixPrzestarzała fasada zgodności Matrix dla starszych pakietów kanałów innych firm; nowe pluginy powinny importować plugin-sdk/run-command bezpośrednio
plugin-sdk/mattermostPrzestarzała fasada zgodności Mattermost dla starszych pakietów kanałów innych firm; nowe pluginy powinny importować generyczne ścieżki podrzędne SDK bezpośrednio
plugin-sdk/runtime-storecreatePluginRuntimeStore
plugin-sdk/plugin-runtimeWspółdzielone helpery poleceń/hooków/http/interaktywnych pluginów
plugin-sdk/hook-runtimeWspółdzielone helpery potoku Webhooków/hooków wewnętrznych
plugin-sdk/lazy-runtimeHelpery leniwego importu/powiązań środowiska uruchomieniowego, takie jak createLazyRuntimeModule, createLazyRuntimeMethod i createLazyRuntimeSurface
plugin-sdk/process-runtimeHelpery wykonywania procesów
plugin-sdk/cli-runtimeHelpery formatowania CLI, oczekiwania, wersji, wywołań argumentów i leniwych grup poleceń
plugin-sdk/gateway-runtimeKlient Gateway, helper uruchamiania klienta gotowego na pętlę zdarzeń, RPC CLI Gateway, błędy protokołu Gateway i helpery poprawek statusu kanału
plugin-sdk/config-contractsSkupiona, wyłącznie typowa powierzchnia konfiguracji dla kształtów konfiguracji pluginów, takich jak OpenClawConfig oraz typy konfiguracji kanałów/dostawców
plugin-sdk/plugin-config-runtimeHelpery wyszukiwania konfiguracji pluginów w środowisku uruchomieniowym, takie jak requireRuntimeConfig, resolvePluginConfigObject i resolveLivePluginConfigObject
plugin-sdk/config-mutationHelpery transakcyjnej mutacji konfiguracji, takie jak mutateConfigFile, replaceConfigFile i logConfigUpdated
plugin-sdk/runtime-config-snapshotHelpery migawki konfiguracji bieżącego procesu, takie jak getRuntimeConfig, getRuntimeConfigSnapshot i settery migawek testowych
plugin-sdk/telegram-command-configNormalizacja nazw/opisów poleceń Telegram oraz sprawdzanie duplikatów/konfliktów, nawet gdy dołączona powierzchnia kontraktu Telegram jest niedostępna
plugin-sdk/text-autolink-runtimeWykrywanie autolinków odwołań do plików bez szerokiego modułu zbiorczego tekstu
plugin-sdk/approval-runtimeHelpery zatwierdzania exec/pluginów, konstruktory capability zatwierdzania, helpery uwierzytelniania/profili, helpery natywnego routingu/środowiska uruchomieniowego i formatowanie ścieżek wyświetlania ustrukturyzowanych zatwierdzeń
plugin-sdk/reply-runtimeWspółdzielone helpery środowiska uruchomieniowego wiadomości przychodzących/odpowiedzi, dzielenie na fragmenty, wysyłka, Heartbeat, planer odpowiedzi
plugin-sdk/reply-dispatch-runtimeWąskie helpery wysyłki/finalizacji odpowiedzi i etykiet rozmów
plugin-sdk/reply-historyWspółdzielone helpery historii odpowiedzi krótkiego okna i znaczniki, takie jak buildHistoryContext, HISTORY_CONTEXT_MARKER, recordPendingHistoryEntry i clearHistoryEntriesIfEnabled
plugin-sdk/reply-referencecreateReplyReferencePlanner
plugin-sdk/reply-chunkingWąskie helpery dzielenia tekstu/markdownu na fragmenty
plugin-sdk/session-store-runtimeHelpery ścieżki magazynu sesji, klucza sesji, czasu aktualizacji i mutacji magazynu
plugin-sdk/cron-store-runtimeHelpery ścieżki/wczytywania/zapisywania magazynu Cron
plugin-sdk/state-pathsHelpery ścieżek katalogu stanu/OAuth
plugin-sdk/routingHelpery routingu/klucza sesji/powiązania konta, takie jak resolveAgentRoute, buildAgentSessionKey i resolveDefaultAgentBoundAccountId
plugin-sdk/status-helpersWspółdzielone helpery podsumowania statusu kanału/konta, wartości domyślne stanu środowiska uruchomieniowego i helpery metadanych problemów
plugin-sdk/target-resolver-runtimeWspółdzielone helpery resolwera celu
plugin-sdk/string-normalization-runtimeHelpery normalizacji slugów/ciągów znaków
plugin-sdk/request-urlWyodrębnianie adresów URL jako ciągów znaków z wejść podobnych do fetch/request
plugin-sdk/run-commandUruchamiacz poleceń z limitem czasu i znormalizowanymi wynikami stdout/stderr
plugin-sdk/param-readersWspólne czytniki parametrów narzędzi/CLI
plugin-sdk/tool-payloadWyodrębnianie znormalizowanych ładunków z obiektów wyników narzędzi
plugin-sdk/tool-sendWyodrębnianie kanonicznych pól celu wysyłki z argumentów narzędzia
plugin-sdk/temp-pathWspółdzielone helpery ścieżek tymczasowych pobrań i prywatne bezpieczne tymczasowe przestrzenie robocze
plugin-sdk/logging-coreRejestrator podsystemu i helpery redakcji
plugin-sdk/markdown-table-runtimeHelpery trybu tabel Markdown i konwersji
plugin-sdk/model-session-runtimeHelpery nadpisań modelu/sesji, takie jak applyModelOverrideToSessionEntry i resolveAgentMaxConcurrent
plugin-sdk/talk-config-runtimeHelpery rozwiązywania konfiguracji dostawcy rozmów
plugin-sdk/json-storeMałe helpery odczytu/zapisu stanu JSON
plugin-sdk/file-lockHelpery reentrantnej blokady pliku
plugin-sdk/persistent-dedupeHelpery pamięci podręcznej deduplikacji opartej na dysku
plugin-sdk/acp-runtimeHelpery środowiska uruchomieniowego/sesji ACP i wysyłki odpowiedzi
plugin-sdk/acp-runtime-backendLekkie helpery rejestracji backendu ACP i wysyłki odpowiedzi dla pluginów ładowanych przy starcie
plugin-sdk/acp-binding-resolve-runtimeTylko do odczytu rozwiązywanie powiązań ACP bez importów uruchamiania cyklu życia
plugin-sdk/agent-config-primitivesWąskie prymitywy schematu konfiguracji środowiska uruchomieniowego agenta
plugin-sdk/boolean-paramLuźny czytnik parametrów logicznych
plugin-sdk/dangerous-name-runtimeHelpery rozwiązywania dopasowań niebezpiecznych nazw
plugin-sdk/device-bootstrapHelpery rozruchu urządzenia i tokenów parowania
plugin-sdk/extension-sharedWspółdzielone prymitywy pasywnego kanału, statusu i helperów ambient proxy
plugin-sdk/models-provider-runtimeHelpery odpowiedzi polecenia/dostawcy /models
plugin-sdk/skill-commands-runtimeHelpery listowania poleceń Skills
plugin-sdk/native-command-registryHelpery rejestru/budowania/serializacji natywnych poleceń
plugin-sdk/agent-harnessEksperymentalna powierzchnia zaufanego pluginu dla niskopoziomowych uprzęży agentów: typy uprzęży, helpery sterowania/przerywania aktywnego uruchomienia, helpery mostu narzędzi OpenClaw, helpery polityki narzędzi planu środowiska uruchomieniowego, klasyfikacja wyniku terminala, helpery formatowania/szczegółów postępu narzędzi i narzędzia wyników prób
plugin-sdk/provider-zai-endpointPrzestarzała, należąca do dostawcy Z.AI fasada wykrywania endpointów; użyj publicznego API pluginu Z.AI
plugin-sdk/async-lock-runtimeHelper lokalnej dla procesu blokady asynchronicznej dla małych plików stanu środowiska uruchomieniowego
plugin-sdk/channel-activity-runtimeHelper telemetrii aktywności kanału
plugin-sdk/concurrency-runtimeHelper ograniczonej współbieżności zadań asynchronicznych
plugin-sdk/dedupe-runtimeHelpery pamięci podręcznej deduplikacji w pamięci
plugin-sdk/delivery-queue-runtimeHelper opróżniania oczekujących wysyłek wychodzących
plugin-sdk/file-access-runtimeHelpery bezpiecznych ścieżek plików lokalnych i źródeł mediów
plugin-sdk/heartbeat-runtimeHelpery wybudzania, zdarzeń i widoczności Heartbeat
plugin-sdk/number-runtimeHelper koercji liczbowej
plugin-sdk/secure-random-runtimeHelpery bezpiecznych tokenów/UUID
plugin-sdk/system-event-runtimeHelpery kolejki zdarzeń systemowych
plugin-sdk/transport-ready-runtimeHelper oczekiwania na gotowość transportu
plugin-sdk/infra-runtimePrzestarzały shim zgodności; użyj powyższych skupionych ścieżek podrzędnych środowiska uruchomieniowego
plugin-sdk/collection-runtimeMałe helpery ograniczonej pamięci podręcznej
plugin-sdk/diagnostic-runtimeHelpery flag diagnostycznych, zdarzeń i kontekstu śledzenia
plugin-sdk/error-runtimeGraf błędów, formatowanie, współdzielone helpery klasyfikacji błędów, isApprovalNotFoundError
plugin-sdk/fetch-runtimeOpakowany fetch, proxy, opcja EnvHttpProxyAgent i helpery przypiętego wyszukiwania
plugin-sdk/runtime-fetchŚwiadomy dispatchera fetch środowiska uruchomieniowego bez importów proxy/guarded-fetch
plugin-sdk/response-limit-runtimeOgraniczony czytnik treści odpowiedzi bez szerokiej powierzchni środowiska uruchomieniowego mediów
plugin-sdk/session-binding-runtimeBieżący stan powiązania rozmowy bez skonfigurowanego routingu powiązań lub magazynów parowania
plugin-sdk/session-store-runtimeHelpery magazynu sesji bez szerokich importów zapisu/utrzymania konfiguracji
plugin-sdk/context-visibility-runtimeRozwiązywanie widoczności kontekstu i filtrowanie kontekstu uzupełniającego bez szerokich importów konfiguracji/zabezpieczeń
plugin-sdk/string-coerce-runtimeWąskie helpery koercji i normalizacji prymitywnych rekordów/ciągów znaków bez importów markdownu/logowania
plugin-sdk/host-runtimeHelpery normalizacji nazwy hosta i hosta SCP
plugin-sdk/retry-runtimeHelpery konfiguracji ponawiania i uruchamiania ponowień
plugin-sdk/agent-runtimeHelpery katalogu/tożsamości/przestrzeni roboczej agenta, w tym resolveAgentDir, resolveDefaultAgentDir i przestarzały eksport zgodności resolveOpenClawAgentDir
plugin-sdk/directory-runtimeZapytanie/deduplikacja katalogu oparta na konfiguracji
plugin-sdk/keyed-async-queueKeyedAsyncQueue
PodścieżkaGłówne eksporty
plugin-sdk/media-runtimeWspółdzielone helpery pobierania/przekształcania/przechowywania multimediów, wykrywanie wymiarów wideo oparte na ffprobe oraz konstruktory ładunków multimedialnych
plugin-sdk/media-mimeWąska normalizacja MIME, mapowanie rozszerzeń plików, wykrywanie MIME oraz helpery rodzaju multimediów
plugin-sdk/media-storeWąskie helpery magazynu multimediów, takie jak saveMediaBuffer
plugin-sdk/media-generation-runtimeWspółdzielone helpery przełączania awaryjnego generowania multimediów, wybór kandydatów oraz komunikaty o brakującym modelu
plugin-sdk/media-understandingTypy dostawcy rozumienia multimediów oraz eksporty helperów obrazów/dźwięku przeznaczone dla dostawców
plugin-sdk/text-chunkingHelpery dzielenia/renderowania tekstu i markdown, konwersja tabel markdown, usuwanie tagów dyrektyw oraz narzędzia bezpiecznego tekstu
plugin-sdk/text-chunkingHelper dzielenia tekstu wychodzącego
plugin-sdk/speechTypy dostawcy mowy oraz eksporty dyrektyw, rejestru, walidacji, konstruktora TTS zgodnego z OpenAI i helperów mowy przeznaczone dla dostawców
plugin-sdk/speech-coreWspółdzielone typy dostawcy mowy, rejestr, dyrektywa, normalizacja oraz eksporty helperów mowy
plugin-sdk/realtime-transcriptionTypy dostawcy transkrypcji w czasie rzeczywistym, helpery rejestru oraz współdzielony helper sesji WebSocket
plugin-sdk/realtime-voiceTypy dostawcy głosu w czasie rzeczywistym i helpery rejestru
plugin-sdk/image-generationTypy dostawcy generowania obrazów oraz helpery zasobów obrazów/adresów URL danych i konstruktor dostawcy obrazów zgodny z OpenAI
plugin-sdk/image-generation-coreWspółdzielone typy generowania obrazów, przełączanie awaryjne, uwierzytelnianie i helpery rejestru
plugin-sdk/music-generationTypy dostawcy/żądania/wyniku generowania muzyki
plugin-sdk/music-generation-coreWspółdzielone typy generowania muzyki, helpery przełączania awaryjnego, wyszukiwanie dostawcy oraz parsowanie odwołań do modeli
plugin-sdk/video-generationTypy dostawcy/żądania/wyniku generowania wideo
plugin-sdk/video-generation-coreWspółdzielone typy generowania wideo, helpery przełączania awaryjnego, wyszukiwanie dostawcy oraz parsowanie odwołań do modeli
plugin-sdk/webhook-targetsRejestr celów Webhook i helpery instalowania tras
plugin-sdk/webhook-pathPrzestarzały alias zgodności; użyj plugin-sdk/webhook-ingress
plugin-sdk/web-mediaWspółdzielone helpery ładowania zdalnych/lokalnych multimediów
plugin-sdk/zodPrzestarzały reeksport zgodności; importuj zod bezpośrednio z zod
plugin-sdk/testingLokalny dla repozytorium, przestarzały barrel zgodności dla starszych testów OpenClaw. Nowe testy repozytorium powinny zamiast tego importować ukierunkowane lokalne podścieżki testowe, takie jak plugin-sdk/agent-runtime-test-contracts, plugin-sdk/plugin-test-runtime, plugin-sdk/channel-test-helpers, plugin-sdk/test-env lub plugin-sdk/test-fixtures
plugin-sdk/plugin-test-apiLokalny dla repozytorium, minimalny helper createTestPluginApi do bezpośrednich testów jednostkowych rejestracji pluginów bez importowania mostków helperów testowych repozytorium
plugin-sdk/agent-runtime-test-contractsLokalne dla repozytorium natywne fixtury kontraktów adaptera środowiska wykonawczego agenta dla testów uwierzytelniania, dostarczania, fallbacku, hooków narzędzi, nakładki promptu, schematu i projekcji transkryptu
plugin-sdk/channel-test-helpersLokalne dla repozytorium helpery testowe zorientowane na kanały dla ogólnych kontraktów akcji/konfiguracji/statusu, asercji katalogów, cyklu życia uruchamiania konta, wątkowania konfiguracji wysyłania, mocków środowiska wykonawczego, problemów statusu, dostarczania wychodzącego i rejestracji hooków
plugin-sdk/channel-target-testingLokalny dla repozytorium współdzielony zestaw przypadków błędów rozwiązywania celu dla testów kanałów
plugin-sdk/plugin-test-contractsLokalne dla repozytorium helpery kontraktów pakietu pluginu, rejestracji, publicznego artefaktu, bezpośredniego importu, runtime API i efektów ubocznych importu
plugin-sdk/provider-test-contractsLokalne dla repozytorium helpery kontraktów środowiska wykonawczego dostawcy, uwierzytelniania, wykrywania, onboardingu, katalogu, kreatora, możliwości multimedialnych, zasad odtwarzania, dźwięku na żywo STT w czasie rzeczywistym, wyszukiwania/pobierania w sieci oraz strumienia
plugin-sdk/provider-http-test-mocksLokalne dla repozytorium opcjonalne mocki HTTP/uwierzytelniania Vitest dla testów dostawców, które ćwiczą plugin-sdk/provider-http
plugin-sdk/test-fixturesLokalne dla repozytorium ogólne fixtury przechwytywania środowiska wykonawczego CLI, kontekstu piaskownicy, pisarza Skills, wiadomości agenta, zdarzenia systemowego, przeładowania modułu, ścieżki spakowanego pluginu, tekstu terminala, dzielenia tekstu, tokenu uwierzytelniania i typowanych przypadków
plugin-sdk/test-node-mocksLokalne dla repozytorium ukierunkowane helpery mocków wbudowanych Node do użycia wewnątrz fabryk Vitest vi.mock("node:*")
PodścieżkaGłówne eksporty
plugin-sdk/memory-corePowierzchnia helperów spakowanego memory-core dla helperów menedżera/konfiguracji/plików/CLI
plugin-sdk/memory-core-engine-runtimeFasada środowiska wykonawczego indeksu/wyszukiwania pamięci
plugin-sdk/memory-core-host-engine-foundationEksporty silnika podstaw hosta pamięci
plugin-sdk/memory-core-host-engine-embeddingsKontrakty osadzeń hosta pamięci, dostęp do rejestru, lokalny dostawca oraz ogólne helpery wsadowe/zdalne
plugin-sdk/memory-core-host-engine-qmdEksporty silnika QMD hosta pamięci
plugin-sdk/memory-core-host-engine-storageEksporty silnika przechowywania hosta pamięci
plugin-sdk/memory-core-host-multimodalHelpery multimodalne hosta pamięci
plugin-sdk/memory-core-host-queryHelpery zapytań hosta pamięci
plugin-sdk/memory-core-host-secretHelpery sekretów hosta pamięci
plugin-sdk/memory-core-host-eventsPrzestarzały alias zgodności; użyj plugin-sdk/memory-host-events
plugin-sdk/memory-core-host-statusHelpery statusu hosta pamięci
plugin-sdk/memory-core-host-runtime-cliHelpery środowiska wykonawczego CLI hosta pamięci
plugin-sdk/memory-core-host-runtime-coreHelpery głównego środowiska wykonawczego hosta pamięci
plugin-sdk/memory-core-host-runtime-filesHelpery plików/środowiska wykonawczego hosta pamięci
plugin-sdk/memory-host-coreNeutralny względem dostawcy alias dla helperów głównego środowiska wykonawczego hosta pamięci
plugin-sdk/memory-host-eventsNeutralny względem dostawcy alias dla helperów dziennika zdarzeń hosta pamięci
plugin-sdk/memory-host-filesPrzestarzały alias zgodności; użyj plugin-sdk/memory-core-host-runtime-files
plugin-sdk/memory-host-markdownWspółdzielone helpery zarządzanego markdown dla pluginów powiązanych z pamięcią
plugin-sdk/memory-host-searchFasada środowiska wykonawczego aktywnej pamięci dla dostępu do menedżera wyszukiwania
plugin-sdk/memory-host-statusPrzestarzały alias zgodności; użyj plugin-sdk/memory-core-host-status
Obecnie nie ma zarezerwowanych podścieżek SDK spakowanych helperów. Helpery specyficzne dla właściciela znajdują się w pakiecie pluginu właściciela, a kontrakty hosta wielokrotnego użytku korzystają z ogólnych podścieżek SDK, takich jak plugin-sdk/gateway-runtime, plugin-sdk/security-runtime i plugin-sdk/plugin-config-runtime.

​
Powiązane