.env.example

# Copy to .env and fill in. .env is gitignored; this file is not.
#
# Better yet, put these in ~/.config/forman/.env instead: the key is per-person,
# not per-repo, and Forman runs from inside whichever repo you point it at.

# Required. https://linear.app/settings/api -> Personal API keys -> Create key
LINEAR_API_KEY=lin_api_xxxxxxxxxxxxxxxxxxxx

# Optional. Only needed when more than one team is visible to your account,
# and only for `forman push` (which has to pick a team to create issues on).
# LINEAR_TEAM_KEY=TEAM

# Optional. Who to filter tickets for and assign new tickets to. Leave this
# unset and Forman uses whoever owns the API key, which is what you want on a
# personal key and cannot drift if someone renames themselves. Set it only to
# act as someone else, e.g. a shared key filing work for a teammate. Accepts an
# email, display name, full name, or user id.
# LINEAR_USER=teammate@example.com

# Optional. The exact workflow state name to move a ticket into at the gate.
# Forman matches anything containing "review" by default; set this if your
# team calls it something else. Run `forman doctor` to see the real names.
# LINEAR_REVIEW_STATE=In Review

# Optional. The exact workflow state to move a ticket into while Forman is
# working it. By default it takes the leftmost column in Linear's "started"
# group that is not a review state, which covers In Progress, Doing, and WIP.
# LINEAR_PROGRESS_STATE=In Progress

# Optional. The label `forman push` stamps on what it creates, and the one
# `forman pull` requires before it will start a ticket on its own. Defaults to
# "forman". It is a speed bump, not a wall: label a ticket by hand to opt it
# in, name it with `--ticket`, or run `forman pull --any` to ignore it.
# FORMAN_LABEL=forman