tbdflow

tbdflow, a Trunk-Based Development CLI

tbdflow is a lightweight command-line tool that helps you (and your team) stay in flow with Trunk-Based Development (TBD).

This CLI supports both the default commit-to-main workflow and the structured handling of short-lived branches for features, releases, and hotfixes.

Philosophy

This tool is built around a specific philosophy of Trunk-Based Development:

• Main is the default. The commit command is your everyday go-to. It automates pulling the latest changes, committing, and pushing directly to main, promoting small, frequent integrations.
• Branches are the exception. While feature, release, and hotfix branches are supported, they’re treated as short-lived exceptions and not the norm.
• Cleanup is automatic. The complete command enforces branch short-livedness by merging and automatically tagging (release/hotfix) and deleting completed branches, helping keep your repo tidy.
• Conventional Commits encouraged. Commit messages follow Conventional Commits for clarity and consistency.

Why not just use Git?

This CLI isn’t a replacement for Git. You’ll still reach for raw git when doing advanced work like rebasing, cherry-picking, or running git bisect.

This tool is as a workflow assistant, tbdflow encapsulates a repeatable, opinionated process to support your day-to-day development.

It offers three main benefits:

1. Consistency across the team Everyone follows the same steps for common tasks. Commits, branches, and releases are handled the same way every time, keeping your Git history clean and predictable.

2. Less to remember No need to recall the exact flags or sequences (like pull --rebase, merge --no-ff, or commit message formats). The CLI handles that, so you can stay focused on writing code.

3. It supports "the TBD way" This tool makes the preferred approach easy by providing a smooth, safe, and efficient path for 80% of everyday tasks. For the other 20%, you can always use Git directly.

Installation

You need Rust and Cargo installed.

Installing from crates.io

The easiest way to install tbdflow is to download it from crates.io. You can do it using the following command:

cargo install tbdflow

If you want to update tbdflow to the latest version, execute the following command:

tbdflow update

Building from source

Alternatively you can build tbdflow from source using Cargo:

git clone https://github.com/cladam/tbdflow.git
cd tbdflow
sudo cargo install --path . --root /usr/local

Configuration

tbdflow is configurable via two optional files in the root of your repository. To get started quickly, run tbdflow init to generate default versions of these files.

.tbdflow.yml This file controls the core workflow of the tool. You can customize:

• The name of your main branch (e.g., main, trunk).
• Branch name prefixes (e.g. feat- instead of feature_).
• The threshold for stale branch warnings.
• Automatic tagging formats.
• Commit message linting rules.

.dod.yml This file controls the interactive Definition of Done checklist for the commit command.

Features

The Definition of Done (DoD) Check

To move beyond just automating process, tbdflow integrates an optional pre-commit quality check. If a .dod.yml file is present in your repository, the commit command will present an interactive checklist to ensure your work meets the team's agreed-upon standards.

Example .dod.yml:

# .dod.yml in your project root

checklist:
  - "All relevant automated tests pass successfully."
  - "New features or fixes are covered by new tests."
  - "Security implications of this change have been considered."
  - "Relevant documentation (code comments, READMEs) is updated."

If you try to proceed without checking all items, the tool will offer to add a TODO list to your commit message footer, ensuring the incomplete work is tracked directly in your Git history.

Commit Message Linting

If a .tbdflow.yml file is present and contains a lint section, the commit command will automatically validate your commit message against the configured rules before the DoD check. This provides immediate feedback on stylistic and structural conventions.

Default linting rules:

main_branch_name: main
stale_branch_threshold_days: 1
branch_prefixes:
  feature: feature_
  release: release_
  hotfix: hotfix_
automatic_tags:
  release_prefix: v
  hotfix_prefix: hotfix_
lint:
  conventional_commit_type:
    enabled: true
    allowed_types:
    - build
    - chore
    - ci
    - docs
    - feat
    - fix
    - perf
    - refactor
    - revert
    - style
    - test
  issue_key_missing:
    enabled: false
    pattern: ^[A-Z]+-\d+$
  subject_line_rules:
    subject_line_max_length: 72
    subject_line_not_capitalized: true
    subject_line_no_period: true
  body_line_rules:
    body_max_line_length: 80

---

Global options

Flag	Description	Required
--verbose	Prints the underlying Git commands as they are executed.	No

Commands

1. commit

This is the primary command for daily work.

Commits staged changes using a Conventional Commits message. This command is context-aware:

• On main: It runs the full TBD workflow: pulls the latest changes with rebase, commits, and pushes.
• On any other branch: It simply commits and pushes, allowing you to save work-in-progress.

Usage:

tbdflow commit [options]

Options:

Flag	Option	Description	Required
-t	--type	The type of commit (e.g., feat, fix, chore).	Yes
-s	--scope	The scope of the changes (e.g., api, ui).	No
-m	--message	The descriptive commit message (subject line).	Yes
	--body	Optional multi-line body for the commit message.	No
-b	--breaking	Mark the commit as a breaking change.	No
	--breaking-description	Provide a description for the 'BREAKING CHANGE:' footer.	No
	--tag	Optionally add and push an annotated tag to this commit.	No
	--issue	Optionally add an issue reference to the footer.	No
	--no-verify	Bypass the interactive DoD checklist.	No

Example:

# A new feature
tbdflow commit -t feat -s auth -m "add password reset endpoint"

# A bug fix with a breaking change
tbdflow commit -t fix -m "correct user permission logic" -b
tbdflow commit -t refactor -m "rename internal API" --breaking --breaking-description "The `getUser` function has been renamed to `fetchUser`."

# A bug fix with a new tag
tbdflow commit -t fix -m "correct user permission logic" --tag "v1.1.1"

2.feature / release / hotfix

Creates a new, short-lived branch from the latest version of `main.

Usage:

# For features or hotfixes
tbdflow <feature|hotfix> --name <branch-name>

# For releases
tbdflow release --version <version-number> [options]

Options (release):

Flag	Option	Description	Required
-f	--from-commit	Optional commit hash on main to branch from.	No

Examples:

# Create a feature branch
tbdflow feature -n "user-profile-page"

# Create a release branch
tbdflow release -v "2.1.0"

# Create a release branch from a specific commit
tbdflow release -v "2.1.0" -f "39b68b5"

# Create a hotfix branch
tbdflow hotfix -n "critical-auth-bug"

3. complete

Merges a short-lived branch back into main, then deletes the local and remote copies of the branch.

Automatic Tagging:

• When completing a release branch, a tag (e.g., v1.2.0) is automatically created and pushed.
• When completing a hotfix branch, a tag (e.g., hotfix_name-of-fix) is automatically created and pushed.

Usage:

tbdflow complete --type <branch-type> --name <branch-name>

Options:

Flag	Option	Description	Required
-t	--type	The type of branch: feature, release, or hotfix.	Yes
-n	--name	The name or version of the branch to complete.	Yes

Examples:

# Complete a feature branch
tbdflow complete -t feature -n "user-profile-page"

# Complete a release branch (this will be tagged v2.1.0)
tbdflow complete -t release -n "2.1.0"

4. Misc commands

tbdflow has a couple of commands that can be beneficial to use but they are not part of the workflow, they are for inspecting the state of the repository.

Examples:

# Does a pull, shows latest changes to main branch, and warns about stale branches.
tbdflow sync

# Checks the status of the working dir
tbdflow status

# Shows the current branch name
tbdflow current-branch

# Explicitly checks for local branches older than one day.
tbdflow check-branches

# Checks for a new version of tbdflow and updates it if available.
tbdflow update

5. Advanced Usage

Shell Completion

To make tbdflow even faster to use, you can enable shell completion. Add one of the following lines to your shell's configuration file.

For Zsh (~/.zshrc):

eval "$(tbdflow generate-completion zsh)"

For Bash (~/.bashrc):

eval "$(tbdflow generate-completion bash)"

For Fish (~/.config/fish/config.fish):

tbdflow generate-completion fish | source

Man Page Generation

You can generate a man page for tbdflow by running the following command:

tbdflow generate-man-page > tbdflow.1