wtm run
Manage dev jobs (services + tasks)
Synopsis
Section titled “Synopsis”Run commands and profiles declared in
Vocabulary:
job the unit wtm runs; its kind is service (long-running) or task (one-shot)
profile a named, ordered group of jobs
compose stack a job that runs docker compose; an isolated worktree gets its own compose project
shared service a job with scope = "shared": one instance for the repository, run in
the main checkout; a worktree holding it reports it as joined
namespace a worktree's own part of a shared service — a database, a realm
named URL the address the run proxy serves (http://api.feat-x.myrepo.localhost)
port URL the job's own port (http://localhost:4012), printed with --raw
isolation isolated: the worktree gets its own ports, compose project and namespaces;
verbatim: it keeps its source's values, and so shares its source's data
touches the services whose data a task changes (a migration, a reset, a seed)
foreign data data this worktree does not own: its source's when it is verbatim,
every worktree's for a shared service with no namespace; a job whose
touches reach it is refused unless --force
[worktree] a worktree's branch name, never a path; omitted, the current worktree
wtm run [flags]Examples
Section titled “Examples” # Once per repository: detect compose files and package scripts wtm run init
# Start the default profile in this worktree wtm run up
# What runs, across every repository wtm run ps
wtm run downOptions
Section titled “Options” -h, --help help for runOptions inherited from parent commands
Section titled “Options inherited from parent commands” -q, --quiet Silence human output; errors and the exit code are unaffected, and --output json still emits its documentSEE ALSO
Section titled “SEE ALSO”- wtm - Orchestrate git worktrees and team dev workflows from the terminal
- wtm run addressing - Switch how the .env files spell a job's address
- wtm run daemon - Inspect, stop or restart the process that runs the jobs
- wtm run down - Stop a worktree's running jobs
- wtm run export - Export run.toml as JSON on stdout
- wtm run import - Replace run.toml with a JSON run config
- wtm run init - Configure the run module (services & tasks) for this repo
- wtm run job - Add, remove, or edit jobs in run.toml
- wtm run list - List jobs and profiles declared in run.toml
- wtm run logs - Attach to a job's output
- wtm run open - Open a job's URL in the browser
- wtm run profile - Add, remove, or edit profiles in run.toml
- wtm run proxy - Inspect and install the redirection that serves named URLs on port 80
- wtm run ps - List currently running jobs
- wtm run start - Start a single job
- wtm run stop - Stop one job, in one or more worktrees
- wtm run up - Start a profile's jobs
- wtm run url - Print where a job is reachable in a worktree