Skip to content

chore(_example): add in-memory executor scripts and improve onboarding docs#1605

Open
Scra3 wants to merge 2 commits into
feat/prd-214-server-step-mapperfrom
feat/workflow-executor-local-start
Open

chore(_example): add in-memory executor scripts and improve onboarding docs#1605
Scra3 wants to merge 2 commits into
feat/prd-214-server-step-mapperfrom
feat/workflow-executor-local-start

Conversation

@Scra3
Copy link
Copy Markdown
Member

@Scra3 Scra3 commented May 28, 2026

Summary

  • Adds yarn start and yarn start:in-memory scripts to @forestadmin/workflow-executor using Node's --env-file=.env flag for automatic env loading
  • Adds .env.example with the 3 required variables (AGENT_URL, FOREST_ENV_SECRET, FOREST_AUTH_SECRET)

Onboarding flow

For someone who already has a Forest Admin agent running:

git clone https://github.com/ForestAdmin/agent-nodejs
cd agent-nodejs
git checkout feat/prd-214-server-step-mapper
yarn && yarn build
cd packages/workflow-executor
cp .env.example .env
# Fill in the 3 values
yarn start:in-memory

🤖 Generated with Claude Code

Note

Add in-memory executor npm scripts and update onboarding docs for Quick Start mode

  • Adds start:with-executor:with-openai:in-memory and start:with-executor:with-anthropic:in-memory scripts to package.json, each concurrently launching the agent and the workflow executor in-memory mode with provider-specific AI env vars.
  • Each script waits for the agent to become reachable via curl before starting tsx watch ../workflow-executor/src/cli.ts --pretty --in-memory.
  • Adds start and start:in-memory scripts to workflow-executor/package.json for standalone executor startup using .env.
  • Rewrites _example/README.md to document Quick Start (in-memory) and Persistent (Postgres) modes with updated ports and environment variable instructions.
  • Adds .env.example with AGENT_URL, FOREST_ENV_SECRET, and FOREST_AUTH_SECRET placeholders.

Macroscope summarized 221548f.

@qltysh
Copy link
Copy Markdown

qltysh Bot commented May 28, 2026

Qlty


Coverage Impact

This PR will not change total coverage.

🚦 See full report on Qlty Cloud »

🛟 Help
  • Diff Coverage: Coverage for added or modified lines of code (excludes deleted files). Learn more.

  • Total Coverage: Coverage for the whole repository, calculated as the sum of all File Coverage. Learn more.

  • File Coverage: Covered Lines divided by Covered Lines plus Missed Lines. (Excludes non-executable lines including blank lines and comments.)

    • Indirect Changes: Changes to File Coverage for files that were not modified in this PR. Learn more.

alban bertolini and others added 2 commits May 28, 2026 14:26
…l onboarding

Add `start` and `start:in-memory` yarn scripts that auto-load `.env` via
Node's `--env-file` flag, so contributors only need to copy `.env.example`,
fill in 3 values, and run `yarn start:in-memory` to get the executor running
locally against an existing Forest Admin agent.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…g docs

Add `start:with-executor:with-openai:in-memory` and `:with-anthropic:in-memory`
scripts that skip the Postgres requirement, making it the recommended first-time
onboarding path. Update README to lead with the in-memory quick start and move
the persistent (database) mode to a secondary section.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@Scra3 Scra3 force-pushed the feat/workflow-executor-local-start branch from 037f28b to 221548f Compare May 28, 2026 12:27
@Scra3 Scra3 changed the title chore(workflow-executor): add start scripts and .env.example for local onboarding chore(_example): add in-memory executor scripts and improve onboarding docs May 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant