스킬

Workflow SDK로 TypeScript 함수를 지속 가능하고 재시도 가능하게 만들기

TypeScript 또는 JavaScript 함수에 지속성, 재시도, 관측 가능성을 더한다. 먼저 공식 패키지를 설치하고 서버 쪽에서만 시작한다.

Official source · vercel/workflow

Install

npm install workflow

누구에게 맞나

이 스킬은 TypeScript 또는 JavaScript에서 「지속 가능한」 함수를 쓰고 싶은 사람에게 맞다. 공식은 워크플로 진행을 저장하고, 실패한 단계를 재시도하며, 내장 관측 가능성을 제공한다고 적는다. 이미 Next.js를 쓰며 설정에 공식 래퍼를 넣을 준비가 된 사람에게도 맞다.

브라우저에서 워크플로를 바로 시작하고 싶은 사람에게는 맞지 않는다. 원문은 시작 위치를 API 라우트, Server Action 또는 다른 서버 코드로 한정한다. 아직 npm을 실행할 수 없거나 한 번의 로컬 패키지 설치를 받아들일 수 없으면 설명 읽기에서 멈춘다.

패키지를 넣은 뒤 코딩 에이전트는 node_modules/workflow/docs에서 현재 버전에 맞는 가이드를 읽을 수 있다. 공식 저장소는

https://github.com/vercel/workflow

해당 페이지에 이미 적힌 명령을 따른다.

3분 안에 첫 시도 끝내기

공식이 적은 이 한 설치 경로만 탄다.

전제: 이 머신에서 npm을 실행할 수 있고, 현재 디렉터리는 의존성을 써도 되는 프로젝트다. 먼저 확인한다: npm install workflow는 의존성 목록을 바꾸고 패키지를 내려받는다. 아직 이 프로젝트를 바꾸고 싶지 않으면 실행하지 말 것.

설치 위치: 프로젝트 루트에서 터미널을 열고 위 부작용을 확인한 뒤 실행한다:

npm install workflow

저위험 작업: 패키지를 넣은 뒤 라이브 라우트에서 바로 워크플로를 시작하지 말 것. 먼저 코딩 에이전트가 node_modules/workflow/docs를 읽기 전용으로 열어 현재 버전에 맞는 로컬 가이드가 보이는지 확인하고 Next.js가 써야 할 가져오기 문을 찾게 한다. 파일에 쓰지 말고 밖으로 요청도 보내지 말 것.

성공 신호: 프로젝트 의존성에 workflow 패키지가 나타나고, 로컬에서 node_modules/workflow/docs를 열 수 있으며, 에이전트가 공식 가져오기 import { withWorkflow } from 'workflow/next'를 가리킬 수 있다. 에이전트가 다른 설치 명령을 지어내면 위의 공식 명령으로 돌아가 다시 시도한다.

사용 사례

사례 1: Next.js 프로젝트에 공식 래퍼를 붙인다. 원문이 주는 가져오기는 import { withWorkflow } from 'workflow/next'. 이미 Next.js 프로젝트가 있고 설정 입구를 먼저 확인하고 싶은 사람에게 맞다. 먼저 에이전트가 바꿀 설정 파일을 읽기 전용으로 표시하게 한 뒤 확인 후 쓴다. 원문이 완전한 설정 객체를 펼치지 않으면 「해당 가져오기를 사용」까지로 멈추고 나타나지 않은 옵션을 스스로 보태지 말 것.

사례 2: 서버에서 지속 가능한 워크플로를 시작한다. 원문은 이어서 API 라우트, Server Action 또는 다른 서버 코드에서 워크플로를 시작할 수 있다고 적는다. 이미 패키지를 넣었고 서버 입구가 한 곳 있는 사람에게 맞다. 처음에는 에이전트가 기존 어느 서버 입구에서 시작할지 가리키게 하고, 설명 없는 클라이언트 입구를 새로 만들지 말 것. 진행은 지속되고 실패한 단계는 재시도된다. 재시도 횟수와 관측 패널을 여는 방법은 원문에 없으니 보태지 말 것.

사용 경계

공식 설치 명령은 원문에 한 줄만 적혀 있다: npm install workflow. 나타나지 않은 설치기를 주 경로에 넣지 말 것. 능력은 TypeScript와 JavaScript 함수의 지속성, 실패 재시도, 내장 관측 가능성을 다루며 다른 언어에서 쓸 수 있음을 증명하지 않는다.

시작 위치는 API 라우트, Server Action 또는 다른 서버 코드까지만 적혀 있다. 브라우저나 이름 없는 클라이언트에서 바로 시작하지 말 것. 로컬 문서 경로는 node_modules/workflow/docs이며 코딩 에이전트가 버전에 맞는 가이드를 읽게 한다. 클라이언트 목록은 주지 않으므로 몇몇 도우미 전용이라고 쓰면 안 된다.

비밀키, 큐 백엔드, 프로덕션 관측 계정은 원문에서 펼치지 않는다. 공식 페이지는

https://github.com/vercel/workflow

에이전트가 제안한 명령이 해당 페이지와 다르면 해당 페이지를 따른다.