Where to Find Documentation for k-skill: Complete Guide to Official Resources

All official documentation for k-skill is stored directly in the NomaDamas/k-skill GitHub repository, organized under README.md, the docs/ directory, and per-skill SKILL.md files.

The k-skill repository is a curated collection of ready-to-use AI skills for Korean data and services. Each skill ships with its own feature document and runtime definition, making self-hosted deployment straightforward. This guide maps every documentation resource so you can install, configure, and run skills without guesswork.

Primary Documentation Locations

README.md – Project Overview and Quick Start

The root README.md serves as the entry point for all new users. It contains:

• High-level project description
• Table of all 25+ available skills
• One-line install commands for the full collection or individual skills

Navigate directly: github.com/NomaDamas/k-skill/blob/main/README.md

docs/ Directory – Master Documentation Folder

All user-facing guides live under the docs/ path. This structure separates concerns clearly:

File	Purpose
docs/install.md	Step-by-step installation workflows
docs/setup.md	Credential and environment configuration
docs/security-and-secrets.md	API key and token handling policies
docs/features/*.md	Individual skill documentation (one file per skill)

docs/install.md – Installation Workflows

This file covers both full-stack and per-skill installation. Key procedures include:

# Install the entire k-skill collection (Node ≥ 18 required)

npx --yes skills add NomaDamas/k-skill --all -g

# Install only the "kbo-results" skill

npx --yes skills add NomaDamas/k-skill --skill kbo-results -g

Source: docs/install.md

docs/setup.md – Configuration Guide

Before running skills, configure credentials and environment variables as documented here. This includes setting up API keys for services that require authentication.

Source: docs/setup.md

docs/security-and-secrets.md – Security Policies

This document establishes policies for handling API keys, tokens, and other secrets. Follow these guidelines to avoid exposing credentials in logs or version control.

Source: docs/security-and-secrets.md

docs/features/*.md – Per-Skill Documentation

Each skill has a dedicated markdown file describing:

• Skill name and description
• Required login type (none, API key, or OAuth)
• Feature-specific usage guide with examples

Example: docs/features/k-schoollunch-menu.md covers the school lunch menu skill.

Proxy Server Documentation

The k-skill-proxy package (packages/k-skill-proxy) enables free API calls for services that normally require a key. Its implementation and configuration are documented in the source:

• Core server: packages/k-skill-proxy/src/server.js
• Package README: Overview of deployment and environment variables

Example usage after proxy configuration:

# Set the proxy endpoint

export KSKILL_PROXY_URL=https://k-skill-proxy.nomadamas.org

# Query KOSIS statistics through the proxy

k-skill:kosis-stats --query "population"

Source: proxy server source

SKILL.md Files – Machine-Readable Definitions

Every skill folder contains a SKILL.md file. These files provide the runtime definition consumed by the skill engine:

• Skill metadata (name, version, author)
• Input/output schemas
• Runtime configuration and dependencies

Unlike the human-oriented docs/features/*.md files, SKILL.md is designed for programmatic parsing by the k-skill runtime.

How to Search Documentation Effectively

1. Start with README.md for orientation and the skills table
2. Check docs/features/{skill-name}.md for specific skill instructions
3. Review SKILL.md in the skill folder for technical integration details
4. Consult docs/install.md and docs/setup.md** for environment issues

Summary

• All k-skill documentation resides in the NomaDamas/k-skill repository with no external documentation site
• README.md provides the project index and quick-install commands
• docs/ contains structured guides: installation, setup, security, and per-skill feature docs
• docs/features/*.md offers detailed usage instructions for each of the 25+ skills
• packages/k-skill-proxy/ documents the free-API proxy server at src/server.js
• SKILL.md files in each skill folder provide machine-readable runtime definitions

Frequently Asked Questions

What is the fastest way to find documentation for a specific k-skill?

Navigate to docs/features/{skill-name}.md in the repository. For example, the KBO baseball results skill is documented at docs/features/kbo-results.md. This pattern applies to all 25+ skills in the collection.

Does k-skill have external documentation or a website?

No. The NomaDamas/k-skill repository intentionally keeps all documentation in-repo. This ensures version alignment between code and docs, and allows offline access after cloning.

Where do I find installation instructions for k-skill?

The docs/install.md file covers both global installation (--all) and selective single-skill installation. The root README.md also provides quick-start commands for common scenarios.

How do I configure API keys securely for k-skill skills?

Follow docs/security-and-secrets.md for policies on credential handling, then implement the environment variable patterns shown in docs/setup.md. Never commit keys to version control; use the proxy server (packages/k-skill-proxy) for services that support it.

{
  "mcpServers": {
    "instagit": {
      "command": "npx",
      "args": ["-y", "instagit@latest"]
    }
  }
}