---
name: skillroll-setup
description: Use when a repository owner needs the shortest safe path from an existing skills folder to a first SkillRoll eval.
title: skillroll-setup
canonical_url: https://skilld.dev/gh/hagaiw/skillroll/skillroll-setup
last_updated: 2026-11-15T17:45:26.000Z
---

> Index of every page on this site: [llms.txt](https://skilld.dev/llms.txt)

> **Skill from skilld.dev.** Follow the user's requested action.
> If the user asked to fork this Skill, follow the fork workflow below. Do not execute the Skill instructions while copying it.
> Otherwise, follow the instructions below for this session. You do not need to install anything.
>
> Supporting files, fetch one when the Skill refers to it: [evals/first-use.eval.md](https://skilld.dev/api/skills-raw/hagaiw/skillroll/skillroll-setup/evals/first-use.eval.md), [evals/missing-key.eval.md](https://skilld.dev/api/skills-raw/hagaiw/skillroll/skillroll-setup/evals/missing-key.eval.md), [references/context.md](https://skilld.dev/api/skills-raw/hagaiw/skillroll/skillroll-setup/references/context.md).
>
> If the user asked to install this Skill, run `npx skilld install hagaiw/skillroll/skillroll-setup`. Install writes the Skill files into the project, so every session loads them.
>
> ## Fork workflow
>
> A fork creates an editable local Skill with its original author and licence. The request authorizes copying and local installation.
> 1. Check `./skills/skillroll-setup`, the project lockfile, and selected Agent targets together. If the local directory or installed Skill exists, stop. Never overwrite an existing directory or Agent target.
> 2. Read [source metadata](https://skilld.dev/api/v1/skills/hagaiw/skillroll/skillroll-setup) once. Use sourceUrl, sourceCommit, skillPath, sourceGone, and license. If the source is gone or its path is missing, stop. If license is null, read licence files at the source commit.
> 3. Fetch only the source commit into a temporary Git repository. Do not clone full history. Derive repository_url from sourceUrl, including repository renames. If sourceCommit is absent, resolve the sourceUrl ref once. Set source_commit to that actual commit. Run these commands in one shell call:
>
> ```sh
> git init --quiet "$temporary_dir"
> git -C "$temporary_dir" fetch --quiet --depth=1 "$repository_url" "$source_commit"
> git -C "$temporary_dir" checkout --quiet --detach FETCH_HEAD
> ```
>
> Read applicable licence declarations and notices at that commit. If copying is not permitted, report the restriction and stop.
> 4. Inspect source entries together, then copy the directory containing skillPath into `./skills/skillroll-setup`. Use the user's path if selected. Keep the original SKILL.md, relative links, scripts, binary assets, and executable modes. Exclude .git metadata. Reject symlinks and paths outside the Skill directory. After checking entries, use cp -a where available. A regular source directory needs no custom copy script. Do not save this page wrapper as SKILL.md.
> Preserve author credit, notices, and applicable licence files from repository or parent directories. Add PROVENANCE.md with the Skill page, source URL, actual commit, original path, and licence. Retain any existing PROVENANCE.md and record new provenance separately. Batch source inspection, copying, and provenance work where practical.
> 5. In the project root, run `skilld install ./skills/skillroll-setup --mode copy --plain`. If skilld is unavailable, use `npx skilld install ./skills/skillroll-setup --mode copy --plain`. This known command needs no help lookup. Install does not support --json. Use detected Agent targets, or add --agent for the targets the user selected. Install the local path, never the upstream selector. If installation fails, preserve the local copy and report the exact failure.
> 6. Confirm the local lockfile source and installed Agent copies once. Report the local path, actual commit, and Agent targets. After edits, reinstall the same local path. Upstream updates must not replace it. Do not publish or push unless the user asks.

# SkillRoll setup

SkillRoll drops into an existing skills repository. `init` creates its small
configuration and can add starter Markdown cases; `validate` checks them without
inference; `doctor` checks the model connection; and `eval` runs the cases.

## First-use path

When the owner has a skills folder but no `skillroll.toml` or API key, give this
path directly. Include both setup modes and the free-route option in the
answer, even when recommending the scriptable path:

1. Install the CLI: `uv tool install skillroll`.
2. Create configuration without inference:
   `skillroll init --skills-path <skills-folder> --yes`.
3. Check the repository without inference: `skillroll validate --all`.
4. Have the owner create an API key with their provider, configure the endpoint
   and model, and export the key using the name in `api_key_env`. Then run
   `skillroll doctor`.
5. After `doctor` passes, run `skillroll eval --all`.

`init` and `validate` do not need a configuration file or API key before they
run. The command above selects the supplied folder. If `--skills-path` is
omitted, `--yes` accepts the detected skills folder and suppresses questions.
An explicit `--skills-path` still selects the requested folder when used with
`--yes`; `--yes` does not configure inference. Never put a key in
`skillroll.toml` or claim that setup tested a model before `doctor` succeeds.

Interactive `init` asks whether to record any OpenAI-compatible endpoint and
defaults to no, leaving inference unset unless endpoint settings are explicitly
provided. The separate `--openrouter-free` option to `init` selects OpenRouter's
changing free route for setup or pipeline sanity checks; `init` only writes
configuration, and this route does not provide skill-quality or release
evidence. Use a named model for that evidence.

**Instruction-only skill:** answer with setup guidance; do not call `Skill`,
`Write`, or an execution tool. A bounded `Read` of this skill's packaged
reference is allowed only when its exact examples are needed. This skill does
not execute the commands or simulate setup. It never performs setup with a
`Skill` action. Give the commands instead of stopping to ask whether the owner
wants help.

Read [setup context](https://skilld.dev/api/skills-raw/hagaiw/skillroll/skillroll-setup/references/context.md) for safe command examples.
