Scaffold your first task.

Scaffold your first task

Use this guide when you are creating the first canonical PsyFlow task package for TaskBeacon.

Before you start

  • Pick the canonical task identity and repository name.
  • Keep the local PsyFlow task as the source of truth.
  • Keep metadata, README, config, and runtime code reviewable before adding a browser preview.

Minimal workflow

  1. Create or open the task repository.
  2. Add the task protocol, configuration, and runtime implementation.
  3. Run the local task in development mode.
  4. Add metadata in taskbeacon.yaml.
  5. Write the README before publishing the preview.
  6. Run QA or smoke checks and record anything reviewers need to know.

Source document

The longer upstream tutorial is maintained in the PsyFlow repository:

https://github.com/TaskBeacon/psyflow/blob/main/docs/tutorials/getting_started.md