Toolverse
All skills

write-script-bunnative

by windmill-labs

MUST use when writing Bun Native scripts.

Installation

Pick a client and clone the repository into its skills directory.

Installation

Quick info

Category
DevOps
Views
1

About this skill

MUST use when writing Bun Native scripts.

How to use

  1. Utwórz plik TypeScript ze strukturą skryptu: eksportuj funkcję async o nazwie main, która przyjmuje parametry (np. param1: string) i zwraca obiekt z wynikami. Nie wywoływaj funkcji main bezpośrednio — Windmill zrobi to za Ciebie.

  2. Jeśli potrzebujesz pobrać dane z API, użyj globalnej funkcji fetch dostępnej bez importów. Przykład: const response = await fetch(url); return await response.json();

  3. Aby użyć poświadczeń lub konfiguracji (np. klucz API Stripe), dodaj parametr z typem zasobu w RT namespace: main(stripe: RT.Stripe). Wcześniej sprawdź dostępne typy zasobów w pliku rt.d.ts w katalogu projektu lub uruchom wmill resource-type list --schema.

  4. Umieść plik skryptu w folderze projektu Windmill. Następnie uruchom wmill generate-metadata — polecenie wygeneruje pliki .script.yaml i .lock opisujące metadane skryptu.

  5. Wdróż skrypt na platformę Windmill, uruchamiając wmill sync push. Nie uruchamiaj tych poleceń samodzielnie w skrypcie — poinformuj użytkownika, że powinien je wykonać w terminalu.

  6. Jeśli tworzysz skrypt preprocessora (do obsługi webhooków, HTTP, Kafki itp.), zmień nazwę funkcji na preprocessor i przyjmij parametr event zawierający typ zdarzenia i jego dane.

Related skills