Skip to main content
Every flag you can pass to lift. When no flags are given, Lift runs the pipeline tools specified in your config file (or all tools by default) in passive mode on the latest commit.
lift [flags]

Processing modes

These flags control whether Lift processes a commit, not which tools run.
FlagLongDescription
(none)Passive mode (default). Exits silently if the commit was already processed.
-f--forceForce re-processing even if the commit was already processed. No prompt.
-p--promptPrompt before re-processing an already-processed commit.
Passive mode is the default so you can run lift as often as you like β€” in a hook, an alias, or muscle memory β€” without duplicating work.
# Re-process a commit that Lift already handled
lift -f

# Ask first, then re-process if you confirm
lift -p

Tool selection

When no tool flag is given, Lift runs the tools from the pipeline config setting (default: all four tools). When you pass one or more tool flags, only those tools run, overriding the config.
FlagLongDescription
-m--messageRun Inky (commit message improvement)
-d--docRun Doc (documentation updates)
Tool flags combine freely:
# Run only Inky
lift -m

# Run Inky and Doc
lift -m -d

Task number

FlagLongDescription
-t--task NUMPrepend a task number prefix to the commit message (e.g., TAHO-123:)
The prefix defaults to TAHO and can be overridden via the inky.task_prefix config setting.
# Prepend TAHO-123: to the commit message
lift -t 123

Pull request

FlagLongDescription
--prPrompt to create or update a pull request after the pipeline completes
After all tools finish, Lift asks whether you’d like to open or update a PR. Stack mode enables this automatically.
# Run the pipeline, then prompt for a PR
lift --pr

Cleanup mode

FlagLongDescription
-c--cleanupRevert .md file changes and replace the commit message with a placeholder
Cleanup mode is destructive. It reverts all Markdown file changes from the current commit and replaces the commit message with a placeholder.
# Undo Lift's changes on this commit
lift -c

Output control

FlagLongDescription
-q--quietSuppress progress indicators and minimize output
Useful for scripting or CI environments where animated spinners aren’t wanted.
# Run silently
lift -q

Common combinations

CommandWhat it does
liftFull pipeline, passive mode
lift -fFull pipeline, force re-processing
lift -mInky only
lift -d -fForce re-run Doc only
lift -sStack mode (all commits, then PR prompt)
lift -cCleanup (revert docs and commit message)

Configuration

FlagLongDescription
--configDisplay the resolved configuration reference and exit
--script-dir DIROverride the script directory (overrides config)
--external-scriptsUse legacy bash scripts instead of internal Rust implementations
Run lift --config to see all available configuration options and the resolved merge result.

Preconditions

Lift validates two things before it runs:
  1. Clean working directory β€” uncommitted changes cause Lift to exit with an error. Commit or stash your work first.
  2. Not on the main branch β€” Lift refuses to run on the configured main branch (default: main). Switch to a feature branch first.