Getting Started with `skr`

This tutorial will guide you through creating, building, and running your first Agent Skill with skr.

Prerequisites

git installed
skr installed (see README)
Access to a GitHub repository (options)

1. Create a Skill

First, initialize a new skr project (workspace):

mkdir my-project
cd my-project
skr init

This creates a .skr.yaml configuration file and an .agent/skills directory, which are required for installing skills.

Next, create a directory for your skill:

mkdir my-skill

Create a SKILL.md file in the my-skill/ directory. This is the definition of your skill.

---
name: my-skill
description: A friendly greeting skill
version: 0.1.0
---

# My Skill

This skill allows agents to say hello.

2. Build the Skill

Package your skill into an OCI artifact.

skr build ./my-skill --tag my-skill:v1

You should see output indicating success:

Successfully built artifact for skill 'my-skill'
Tagged as: my-skill:v1

3. Inspect the Artifact

Verify the artifact is in your local system store.

skr system inspect my-skill:v1

You'll see metadata including the size, digest, and creation time.

4. Install the Skill

Install the skill to your agent configuration. Since we just authored the skill locally, we can install it directly from the directory using the file:// schema:

skr install file://./my-skill

This updates your .skr.yaml and synchronizes the skill to .agent/skills.

Note: For sharing with others, you would typically push your skill folder to a Git repository, and others would install it directly via Git (e.g., skr install https://github.com/your-username/my-skill).