workflow
The loop a developer runs all day — pick up a Jira issue, branch for it, open
the pull or merge request, tell the team once CI passes — in the terminal, or
in a browser with workflow --web. The
README says more about what
workflow is; below is what works today, and where to read next.
Status
The whole loop works, and is new: expect rough edges, and a configuration format that may still change before 1.0.
workflowopens the TUI. Pick up an assigned Jira issue, comment on it or change its status, branch for it, stage and commit through the repository’s own hooks — opening a failure at its line in$EDITOR— push, open the pull or merge request from the repository’s template, follow its CI, and announce it to your team.?lists the keys.workflow --dry-rundoes all of that with every write held back, saying what it would have done.workflow --webserves the same loop in a browser, on127.0.0.1alone — issues, the branch and its commits, the pull request and its announcement, your review queue, tasks, the summary, your repositories and the settings — pushed live as the repository changes.- With no Jira configured, the Issues pane lists the issues assigned to you on your forge (GitHub or GitLab) instead — pick one up, branch for it, and the pull request closes it on merge.
- A repository with hooks in
.git/hooksand no lefthook configuration is offered alefthook.ymlthat runs them. workflow doctorreports the repository, tooling and configuration in effect;workflow doctor --onlineasks Jira and your forge whether their credentials work, and Slack whether your user token does, refreshing it if it is due; a webhook cannot be checked without posting, so it is reported unchecked.workflow config initsets up the configuration, answering the prompts (--templatewrites a blank file to edit) — or, with no file, the terminal interface and the web’s Settings ask the same questions — andworkflow config showprints the one in effect, credentials masked.workflow summarysays what you did over a period — the commits you wrote, the tasks you touched, what you did to Jira issues and the pull requests you opened, had merged and reviewed — as the Summary pane reads it;--jsonprints it for a script, and--postposts it to your team after a preview.workflow reviewslists the pull requests on your forge that are waiting on your review — the longest-waiting first, with the author, how CI stands and how long each has waited.
Where to go next
- Install — Homebrew,
go install, release binaries, or build from source. - Using workflow — the panes, the keys, and the loop from issue to announcement.
- The web interface —
workflow --web: its sections, its live stream, and what it leaves to the terminal. - Configuration — every field of
.workflow.json, and how to get the Jira token and a messaging webhook or Slack user token. - Scripting — the commands without the
interface: exit codes, streams and what standard error says,
--json,--yes,--dry-run,--quiet,--verbose,--log-formatand--request-log. - Questions and troubleshooting — what people ask most, and what to do when a setup step, a token or a post does not work.
- Command reference — every command and flag, generated from the code.
- Development — the toolchain, the gates, and how a release happens.
workflow is Apache 2.0 licensed, and the source lives at jacob-delgado/workflow.