Skip to main content

Overview

Getting Started

Recommended

Install Reflow, select the intended repository, initialize local configuration, and preview the first workflow safely.

Commandreflow

Category

Onboarding

Quick Command

reflow --dry-run -C ../project tags convert local
installationrepository targetfirst dry-run

Before You Begin

Features

Python 3.14+

Use a dedicated virtual environment and a reviewed source, release artifact, or authorized private GitLab package.

Git

Local workflows need an existing checkout; URL workflows also need credentials appropriate to the selected remote operation.

Optional External Tools

Release recovery needs the authenticated GitHub CLI. Docker publishing needs Docker and registry authentication.

A Deliberate Target

Know whether the command should use the current directory, an explicit local path, or a Git URL.

Recommended Onboarding Path

1
Install Reflow
Install from a reviewed source checkout, trusted artifact, or the private GitLab PyPI registry.
current
2
Choose the repository
Use the current checkout, -C/--repository, or --repository-url as the command allows.
pending
3
Initialize local configuration
Run reflow init only against a local target and review .config/reflow/config.toml.
pending
4
Preview the workflow
Place global --dry-run before the command path and inspect the displayed target and plan.
pending
5
Execute deliberately
Remove --dry-run only after the documented mutation scope matches your intent.
pending
Safe onboarding sequence
bash
# Prepare project-owned configuration in a local checkout
reflow -C /path/to/project init

# Review the generated configuration and the Git state

git -C /path/to/project status --short

# Preview local tag conversion without changing refs

reflow --dry-run -C /path/to/project tags convert local --to semver

Related Commands

Commands commonly used together with this command.