dvoid docs
WorkbenchGuides

Customizing: templates, playbooks, layouts, workspaces

Make dvoid start, arrange and run your work the way you want, for you alone or for your whole org.

dvoid-io/workbench · partner

"I always open these three repos together", "every security job should start with these instructions", "I want the terminal under the files": each of these is one of four things you can shape.

nounmeanslastsyour own copy lives in
templatewhat a workstream starts from: repos, and optionally the layout it opens inyes~/.config/dvoid/estate.toml [[templates]]
playbookhow the work is done: the AGENTS.md it seeds ({{goals}} etc. substituted), its plugins, its layoutyes~/.config/dvoid/playbooks/<name>.json
layoutan arrangement of console panes, paths relative to ${root} so it fits any workstreamyes~/.config/dvoid/console/layouts/<slug>.json
workspacethe live arrangement for one workstream, folder or Quick; closes with itnothe console's state, never shared

Each kind layers the same way: built-in (shipped with dvoid) < org (what your org's staff manage) < personal (~/.config/dvoid/, yours). A later layer wins a name, and a personal remove = true hides something a lower layer carries.

See what you have

dvoid estate config show --json        # repos and templates, and the layer each came from
dvoid workstream playbook list --json
dvoid workstream playbook show <name>

Change it

# a template
dvoid estate config template set <name> --repos a,b [--layout <id>] [--description "…"]
dvoid estate config template remove <name>   # drops yours; an org's is hidden on this machine
# the repos every sweep includes
dvoid estate config repos add a,b
dvoid estate config repos remove a,b
# a playbook (one named like an org's or a built-in replaces it on this machine)
dvoid workstream playbook set <name> --describe "…" --agents-md "…" [--plugins a,b] [--layout <id>]
dvoid workstream playbook remove <name>
# a workstream from them
dvoid workstream new --template <t> --playbook <p>

Run show or list again to see the result. The Assistant can make these changes for you; each one asks you first and shows the exact command.

Layouts are made in the console: ⋯ → Save workspace as layout, or Ctrl+G then s. It asks for a name and saves the layout relative to the workstream, so it fits the next one. The desktop (Ctrl+G d) opens, favourites, reorders and hides layouts.

Personal or org?

  • Personal when it is yours, an experiment or a preference. This is the default, and reversible.
  • Org when everyone in your org should start from it: a template every new teammate needs, the playbook a kind of work must follow, a layout the team shares. You cannot change the org layer from your machine; your org's staff do. Ask the Assistant to draft the exact entry, then send it to them.

Old words, still heard

Everything older keeps working; dvoid prints one hint: line with the new word.

you may sayit is nowthe old way
taskgroup, --group, [[taskgroups]]template, --template, [[templates]]works; dvoid estate config migrate rewrites the file
workstream type, --type, "type" in a recordplaybook, --playbook, "playbook"works; dvoid workstream migrate --apply rewrites records
F12Ctrl+G (the Commands key, configurable; Ctrl+Shift+P too where the terminal reports Shift)works; the Commands title names the key
"session" (old name for a workstream)workstreamdvoid workstream migrate moves the old folders

Read more

On this page