From installation to your first published workflow

Use this path to develop a workflow locally, publish it to Workflow Server, and manage its runs, access, logs, and integration endpoints in Server Web.

Install the Desktop

Open Desktop downloads, select the macOS Apple Silicon, macOS Intel, or Windows x64 package, and install it. Launch Workflow Code from Applications, the Start menu, or the desktop shortcut.

Create or import a local project

On the Desktop home page, select New project to create a workflow or Import folder to add an existing workflow directory. The project then appears in your local project list.

Edit and run it in the workspace

Open the project, edit source files in Files, enter parameters in Run, and start the workflow. Results appear in the output area; open Trace or Logs from the run history when you need diagnostics.

Configure the local runtime

Add local environment variables in the workspace Env view for credentials or third-party services. These values affect only Desktop runs and are never uploaded automatically.

Publish to Workflow Server

Sign in and select Publish in the workspace. The Desktop saves local files, uploads the project package, and asks the server to create a new version.

Manage the project in Server Web

Open Server Web and select the project. You can manage members, run queues, environment variables, KV, knowledge bases, versions, Embed, Webhooks, and execution logs.

Choose a task

Install the Desktop

Choose the package for your platform and install Workflow Code on macOS or Windows.

Download and install →Create or import a project

Use New project or Import folder to add a workflow to the Desktop.

Open the Desktop guide →Edit, run, and publish

Edit source in Files, run it from Run, and upload a version with Publish.

Open the workspace guide →Sign in, themes, and updates

Manage your account, appearance, client preferences, and updates.

Open Desktop settings →Use Server Web

Sign in, find a project, open its details, and run a published workflow.

Open the Server Web guide →Manage projects and integrations

Configure members, versions, KV, environment variables, Embed, Webhooks, and run queues.

Open project management →

Common tasks

Goal	Path
Create your first workflow	Desktop home New project -> open the workspace -> Files -> Run.
Add an existing workflow	Desktop home Import folder -> select the workflow directory -> open the project.
Test parameters and environment variables locally	Workspace Run -> fill in parameters; Env -> add local variables; then run the workflow.
Publish a runnable version	Workspace Publish -> save files -> upload the project package -> create a server version.
Add credentials for server runs	Server Web project details -> Environment variables -> add or update a variable.
Investigate a failed run	Server Web project details -> Execution logs -> open the detailed log or replay.
Share a page externally	Server Web project details -> Embed -> enable an entrypoint and copy its URL.
Receive events from another system	Server Web project details -> Webhook -> configure signature, mappings, and filters.

Next steps

• Read the core concepts to understand workflows, payloads, KV, files, conversations, and LLM providers.
• Read the Core API when you are ready to write code.
• Read the CLI reference to package, upload, publish, or run projects from a terminal.
• Use the Server API reference when integrating with HTTP endpoints.