ftk-config

Files (9)

• SKILL.md
• project-config.md · references/
• storage-github.md · references/
• storage-local.md · references/
• workflow-template.md · references/
• script-args.js · scripts/
• show-storage-reference.js · scripts/
• update-config.js · scripts/
• update-workflow-docs.js · scripts/

SKILL.md (first lines)

Configure FTK workflow storage and workflow semantics for Specs and derived Work Items.

Store local workflow files relative to the current working directory. Do not resolve storage from the git repository root, do not search parent directories for `.ftk/config.yaml`, and do not `cd` before running FTK config scripts.

## Files

Config path: `.ftk/config.yaml` in the current working directory.
Workflow semantics path: `.ftk/workflow.md` in the current working directory.
Agent guidance path: prefer existing `AGENTS.md`, then existing `CLAUDE.md`. If neither exists, ask which one to create.

Read [project-config.md](./references/project-config.md) for the schema and validation rules.

## Workflow

1. Run the validator: `node ~/.config/flutter-tools-kit/bin/ftk-run-script.js skills/ftk-config/scripts/update-config.js --check`.

2. If config is valid, keep it. Do not ask whether to change it.

3. If config is missing or invalid, select Workflow Storage. Inspect `origin` first with `git remote get-url origin`.

Recommend GitHub when `origin` points to GitHub; otherwise recommend local markdown. Prompt, with `(Recommended)` on the recommended option:

```md
Where should FTK create new Specs for this directory?

Default for this directory: <GitHub|Local markdown>, because <reason>.

Options:
- GitHub: Create new Specs as GitHub Issues for this repository.
- Local markdown: Save new Specs as markdown files under a local path.
```

4. If the user selects GitHub, validate that any configured remote points to GitHub with `git remote -v`.

Accept HTTPS and SSH GitHub remotes. If none exists, do not write config. Ask the user to add a GitHub remote or choose local markdown. Do not check whether `gh` is installed or authenticated.

5. If the user selects local markdown, ask for the local path when missing or invalid:

```md
Where should FTK save local Specs?

Options:
- `ai_specs` (Recommended): Save Specs under `./ai_specs`.
- Custom path: Enter another current-working-directory-relative path.
```

Ask and stop until the user replies.

6. Write config with `skills/ftk-config/scripts/update-config.js`:

```bash
node ~/.config/flutter-tools-kit/bin/ftk-run-script.js skills/ftk-config/scripts/update-config.js --backend local --local-path ai_specs
```

or:

```bash
node ~/.config/flutter-tools-kit/bin/ftk-run-script.js skills/ftk-config/scripts/update-config.js --backend github
```

Expected stdout: `Wrote .ftk/config.yaml`.

If `skills/ftk-config/scripts/update-config.js` rejects the local path, ask again with the same path prompt. Do not hand-write `.ftk/config.yaml`.

7. Ensure workflow semantics and agent guidance after config is valid or written.

If neither `CLAUDE.md` nor `AGENTS.md` exists, ask which one to create: `AGENTS.md` or `CLAUDE.md`.

Run `node ~/.config/flutter-tools-kit/bin/ftk-run-script.js skills/ftk-config/scripts/update-workflow-docs.js`.

If the script reports `NO_AGENT_FILE`, ask the guidance-file question, then run:

```bash
node ~/.config/flutter-tools-kit/bin/ftk-run-script.js skills/ftk-config/scripts/update-workflow-docs.js --agent-file <AGENTS.md|CLAUDE.md>
```

## Completion Report

After config, workflow semantics, and agent guidance are ensured, read `.ftk/config.yaml` and report current settings:

```md
FTK config complete.

Config: `.ftk/config.yaml`
Workflow semantics: `.ftk/workflow.md`
Agent guidance: `<AGENTS.md or CLAUDE.md>`

Configured settings:
- `workflow.backend`: `<local|github>`
- `local.path`: `<path>` when backend is `local`
```

Then stop. Do not invoke another workflow automatically.

From adiwirya/flutter-tools-kit, MIT.

More from adiwirya/flutter-tools-kit