Skip to content

Dataface Master Plans

CLI Reference

Plans CLI Reference¶

The plans command manages Master Plans tasks and initiatives from the command line.

Quick start¶

# Install (one-time) — the plans entrypoint is registered via pyproject.toml
uv sync --extra dev

# All commands below use `plans` (or `uv run plans` outside an activated venv)

Task commands¶

Create a task¶

plans task create \
  --workstream infra-tooling \
  --title "My new task" \
  --description "What this task delivers"

Update a task¶

plans task update --path master_plans/workstreams/infra-tooling/tasks/my-task.md \
  --status in_progress --priority p2

Start a task (shortcut for `--status in_progress`)¶

plans task start --path master_plans/workstreams/infra-tooling/tasks/my-task.md

Complete a task (shortcut for `--status completed`)¶

plans task complete --path master_plans/workstreams/infra-tooling/tasks/my-task.md

plans task complete also stamps completed_at and completed_by in task frontmatter. If a completed task is moved back to another status, that completion metadata is cleared.

List tasks¶

# All tasks across all workstreams
plans task list

# Filter by workstream
plans task list --workstream infra-tooling

# Filter by status (comma-separated)
plans task list --workstream infra-tooling --status not_started,in_progress

Show task details¶

plans task show --path master_plans/workstreams/infra-tooling/tasks/my-task.md

Find task by GitHub issue¶

# By issue number
plans task find --github-issue 301

# By URL fragment
plans task find --github-issue "github.com/fivetran/dataface/issues/301"

Initiative commands¶

Create an initiative¶

plans initiative create \
  --workstream cloud-suite \
  --title "My initiative" \
  --description "Objective of this initiative" \
  --tasks task-slug-1 task-slug-2

Update an initiative¶

plans initiative update \
  --path master_plans/workstreams/cloud-suite/initiatives/my-init/index.md \
  --status in_progress --add-task new-task-slug

Justfile aliases¶

For convenience, the Justfile provides pass-through wrappers:

just mp-task create --workstream ...    # same as: plans task create --workstream ...
just mp-initiative create --workstream ...  # same as: plans initiative create --workstream ...