No description
  • Rust 99.7%
  • JavaScript 0.2%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2026-10-15 14:13:30 +02:00
catalog Final review fixes: criterion-ID warnings in pack, short kind-2 catalogue lines, scenario checks 2026-10-14 19:52:04 +02:00
crates unpack: unbalanced statements in backticks instead of raw; lint WF117 for unclosed quotes 2026-10-15 09:43:28 +02:00
docs Docs: export-live implementation plan; spec: record numbering, file names, Windows check 2026-10-15 14:13:30 +02:00
editors/zed workflow-lsp: workflow.toml events list (WF114 + create event file, WF115), file watchers 2026-10-15 00:26:20 +02:00
fixtures Fixture: Designer export with all SCR fields deleted (companions stay) 2026-10-14 23:49:04 +02:00
tree-sitter-wfx Empty flag field: @flag{} marker instead of raw; wf unpack --empty-flag-as-active 2026-10-14 10:10:12 +02:00
.gitignore Docs: mdBook manual (docs/book), first draft by section 2026-10-15 00:52:04 +02:00
Cargo.lock workflow-eval: corpus smoke test, README (wf run, scenarios), docs 2026-10-14 15:46:06 +02:00
Cargo.toml workflow-eval: crate, engine text and number primitives 2026-10-14 14:51:39 +02:00
README.md README: overview + quickstart, details moved to the mdBook; handover points to the book 2026-10-15 00:53:10 +02:00

wf: Büroware workflow scripts as text

wf lets you write Büroware (SoftENGINE) ERP workflow scripts as plain text files and bring them back into the ERP through the Designer's normal import. It unpacks a Designer export (.DTK) into a folder of editable files, checks them, previews their run, and packs them into a new .DTK. Untouched content packs back byte for byte.

Part Crate / folder
wf command line crates/workflow-cli
Language server workflow-lsp crates/workflow-lsp
Zed extension and grammar editors/zed, tree-sitter-wfx
Libraries workflow-dtk (page files), workflow-script (workflow model), workflow-lang (.wfx syntax, analysis, lints), workflow-pack (unpack/pack), workflow-eval (preview runs)

Manual

The full documentation is an mdBook in docs/book:

mdbook serve docs/book --open
Topic Page
Installation, ERP user, catalog setup/install.md
Zed setup setup/zed.md
Designer, workflows, events, build numbers concepts/erp.md
Unpack, edit, pack, import guide/unpack-pack.md
workflow.toml ([table], [[events]]) guide/workflow-toml.md
fields.toml guide/fields.md
The .wfx language guide/wfx.md
Lint codes guide/lint.md
Editor features guide/editor.md
Preview runs (wf run) guide/preview.md
Relation catalog, ERP versions guide/catalog.md
Every command and flag reference/cli.md
Errors and fixes reference/troubleshooting.md
Repository, tests, research development/repo.md

Quickstart

cargo install --path crates/workflow-cli     # wf
cargo install --path crates/workflow-lsp     # language server (for Zed)

wf unpack EXPORT.DTK my-export/              # one folder per workflow, one .wfx per event
# edit my-export/WF0001/events/*.wfx, workflow.toml, fields.toml
wf lint my-export/
wf pack my-export/ --user 105 -o NEW.DTK     # 105 = your ERP user number (or $WF_USER)

Then import NEW.DTK in the Designer. pack raises the build number of every changed workflow; the import only replaces a workflow whose build is higher than the ERP's.

Development

cargo test --workspace
cargo clippy --workspace --all-targets -- -D warnings
cargo fmt --all --check

Real ERP exports never go into the repository; the fixtures in fixtures/ are synthetic test exports. Details: development/testing.md. Open tasks and the state of the project: docs/handover.md. Reverse-engineering notes: docs/re/.