Skip to content

Latest commit

 

History

History
40 lines (25 loc) · 2.39 KB

File metadata and controls

40 lines (25 loc) · 2.39 KB

CLI entrypoints (do, vodou)

Canonical name: ./do

Use ./do in documentation and tutorials. It is the short launcher for Vodou (orchestration — “do things”).

Launcher files, same bytes (no symlinks)

The repo ships do as the script you edit. Additional launchers are plain-file copies of do (not symlinks) so zip/tar and Windows installs behave reliably.

File Role
do Source of truth — edit this file when changing launcher behavior.
vodou Usual copy of do — same bytes; convenient when you want the product name on the command line. ⚠️ Distinct from the global vodou on your PATH (~/.local/bin/vodoubin/vodou-cli), which is the interactive agentic TUI — see vodou-cli.md.
oi Symlink to do. Prefer ./do in new docs; keep oi on disk for older scripts and muscle memory.
(other filenames) Some bundles ship extra symlinks for backward compatibility; treat them like vodou.

oi and vodou are symlinks to do (P4). There is nothing to refresh after editing do, and nothing should ever cp over them — that recreates the three divergent copies the symlinks replaced. do resolves symlinks itself when finding the project root, which is why this works.

Project root discovery

The script walks up from $PWD for a directory containing vodou-core (or vodou-core.exe) and at least one launcher script (do, vodou, or another shipped copy from the table above).

Direct binary

./vodou-core … bypasses the launcher (no worker fast-path / brain sugar unless you replicate it).

Hook binary (IDE) — not a launcher

./vodou-hook-bin is a separate small binary for Cursor / Claude Code hooks and socket diagnostics (cursor-session, sock prompt, sock flush, ensure, context, etc.). It is not a substitute for ./do: you do not migrate hook configs from oi to do here — hooks call vodou-hook-bin directly.

For setup and behavior, see claude-code-hooks.md and cli-reference.md (hook / flush sections).

Related