faff-onboard

Bootstraps a .faffrc.yaml config by detecting tracker, repo slug, and git host.

3|Updated Apr 16, 2026
One-click install
npx skills add https://github.com/shftwst/faff --skill faff-onboard-shftwst
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: faff-onboard
Source: https://github.com/shftwst/faff/tree/main/plugin/skills/faff-onboard
Command: npx skills add https://github.com/shftwst/faff --skill faff-onboard-shftwst

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Setting up faff for a repository requires a valid .faffrc.yaml, but manually figuring out the tracker, team key, repo slug, and git host is tedious and error-prone. This Skill automates first-run configuration by discovering what it can and asking only for what it cannot infer. ## Core Features & Use Cases - Automatic detection: Inspects connected MCP servers to identify the tracker (Linear, GitHub, Jira) and parses git remote -v to derive the repo slug and git host. - Minimal prompting: Asks only for team_key, tiered by what the tracker MCP reports (confident default, pick-list, or free-text). - Safe, gated writes: Previews the exact config via faff config init --dry-run, requires one confirmation, never overwrites an existing config, and runs idempotent gitignore-ensure and hooks-ensure afterward. - Use Case: You just installed faff in a repo with no .faffrc.yaml. Run the onboarding flow and it detects your Linear MCP and GitHub remote, confirms team SHF, and writes a valid config in one step. ## Quick Start Ask the assistant to set up faff for this repository and confirm the detected values when prompted.

Frequently Asked Questions about faff-onboard

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I set up faff for a repository for the first time?▼

Run the faff-onboard flow, which detects your tracker from connected MCP servers and your repo slug from the git remote, asks only for the team key, previews the config with a dry run, and writes .faffrc.yaml via faff config init after one confirmation.

What values does faff onboarding detect automatically?▼

It detects the tracker (Linear, GitHub, Jira) from connected MCP servers, the repo slug and git host from git remote -v, and record layout paths when they diverge from defaults. Only team_key requires a manual answer since it cannot be inferred.

Does faff-onboard work without a tracker MCP server?▼

Yes, it supports git-only mode. When no tracker MCP is connected, it skips the tracker and team_key values, notes the git-only setup in the closing report, and still writes the remaining detected config values.

What happens if a .faffrc.yaml already exists?▼

Onboarding bails immediately: it reports the existing config path and stops without overwriting anything. A legacy-named config (.faffrc or .faffrc.yml) triggers a loud rename error instead, and only a decline-stub config allows onboarding to proceed.

Can faff-onboard run in autonomous or unattended mode?▼

No, it is interactive-only. Autonomous pipeline runs never trigger onboarding or emit the first-run offer; an unattended run with no config simply proceeds on faff's built-in defaults.