- SOAR sources — the workflows you already automate.
- Documentation sources — the runbooks you already write.
SOAR sources
A SOAR sync reads the workflows on the platform and builds a playbook from each: the workflow becomes the playbook’s workflow, and its documentation is written for it.
Every playbook in your selection is mirrored, and any sub-playbook it calls comes with it — even one outside the selection, since a playbook missing the steps it delegates is not the playbook you run.
Leaving the selection empty means the whole instance, and projects or repositories added later are picked up automatically.
Documentation is written for every playbook a SOAR sync brings in. Later runs leave it alone, so your edits survive — unless you turn on Rewrite the documentation when the workflow changes, which regenerates it whenever the workflow moves and replaces anything edited in Cymph. It is off by default.
Documentation sources
A documentation sync reads files or pages and builds a playbook from each: the document becomes the playbook’s documentation, and its workflow is derived from the text.
From a file-based source, Cymph reads Markdown, PDF, Word, and plain text files (
.md, .markdown, .pdf, .doc, .docx, .txt). Anything else in the same folder is ignored.
Leaving the selection empty means the whole source, and documents added later are picked up automatically.
When a document changes, its documentation in Cymph is always updated. The workflow is another matter: rebuilding it re-reads the new text and replaces any steps edited in Cymph. Rebuild the workflow when the document changes controls that, and it is on by default. Turn it off if you refine workflows in Cymph after they arrive.