Rendre les fonctions TypeScript persistantes et relançables avec le Workflow SDK

Install

npm install workflow

À qui ça s'adresse

Ce skill convient à qui veut écrire des fonctions « persistantes » en TypeScript ou JavaScript : le texte officiel dit qu'il enregistre la progression du workflow, relance les étapes en échec et fournit une observabilité intégrée. Il convient aussi à qui utilise déjà Next.js et prévoit d'accrocher l'enveloppe officielle dans la configuration.

Il ne convient pas à qui veut seulement démarrer un workflow directement dans le navigateur. Le texte source limite le lieu de démarrage aux routes API, Server Action ou autre code serveur. Si vous ne pouvez pas encore exécuter npm, ou n'acceptez pas une installation locale de paquet, arrêtez-vous à la lecture du guide.

Après l'installation du paquet, un agent de code peut lire des guides alignés sur la version courante depuis node_modules/workflow/docs. Le dépôt officiel est

https://github.com/vercel/workflow

Suivez les commandes déjà écrites sur cette page.

Premier essai en 3 minutes

Ne prenez que le seul chemin d'installation écrit officiellement.

Prérequis : cette machine peut exécuter npm, et le répertoire courant est un projet autorisé à recevoir des dépendances. Confirmez d'abord : npm install workflow changera la liste des dépendances et téléchargera un paquet. Si vous ne voulez pas encore changer ce projet, n'exécutez pas.

Emplacement d'installation : ouvrez un terminal à la racine du projet, confirmez ces effets de bord, puis exécutez :

npm install workflow

Tâche à bas risque : une fois le paquet installé, ne vous précipitez pas pour démarrer un workflow dans une route en ligne. Demandez d'abord à l'agent de code d'ouvrir node_modules/workflow/docs en lecture seule, de vérifier qu'un guide local aligné sur la version courante est visible, et de trouver l'import que Next.js doit utiliser. N'écrivez pas de fichiers et n'envoyez pas de requêtes sortantes.

Signal de succès : le paquet workflow apparaît dans les dépendances du projet, node_modules/workflow/docs s'ouvre en local, et l'agent peut indiquer l'import officiel import { withWorkflow } from 'workflow/next'. S'il invente une autre commande d'installation, revenez à la commande officielle ci-dessus et réessayez.

Cas d'usage

Cas 1 : accrocher l'enveloppe officielle à un projet Next.js. L'import donné par le texte est import { withWorkflow } from 'workflow/next'. Cela convient à qui a déjà un projet Next.js et veut d'abord vérifier l'entrée de configuration. Vous pouvez d'abord demander à l'agent de marquer en lecture seule le fichier de configuration à changer, puis écrire après confirmation. Si le texte n'étend pas un objet de configuration complet, arrêtez-vous à « utiliser cet import » ; n'ajoutez pas d'options absentes.

Cas 2 : démarrer un workflow persistant depuis le serveur. Le texte dit qu'on peut ensuite démarrer un workflow depuis une route API, une Server Action ou d'autre code serveur. Cela convient à qui a déjà installé le paquet et possède une entrée serveur. La première fois, demandez à l'agent d'indiquer depuis quelle entrée serveur existante vous démarrerez ; ne créez pas une entrée cliente non expliquée. La progression est persistée et les étapes en échec sont relancées ; le nombre de relances et l'ouverture d'un panneau d'observabilité ne sont pas écrits — n'en inventez pas.

Limites d'usage

Une seule commande d'installation officielle est écrite : npm install workflow. Ne mettez pas un installeur absent sur le chemin principal. Les capacités couvrent la persistance, les relances d'étapes en échec et l'observabilité intégrée pour les fonctions TypeScript et JavaScript ; elles ne prouvent pas l'usage dans d'autres langages.

Le lieu de démarrage n'est écrit que comme routes API, Server Action ou autre code serveur. Ne démarrez pas directement depuis le navigateur ou un client non nommé. Le chemin de docs local est node_modules/workflow/docs, pour qu'un agent de code lise des guides alignés sur la version ; il ne donne pas de liste de clients, donc ne le traitez pas comme exclusif à quelques assistants.

Les secrets, backends de file et comptes d'observabilité de production ne sont pas développés. La page officielle est