使い方
- インストールコマンドをコピーし、自分の環境へ導入する前にソースを確認します。
- 必要なツール、認証情報、対応環境を原文で確認します。
- 入力と成果物を指定し、出力を資料と照合します。
npx skills add https://github.com/xsavikx/okf-skills --skill okf-fs開始前の確認
- 導入にはモデル契約、API枠、ファイルへのアクセス許可は含まれません。
- スター数や導入数は活動の指標であり、独立した品質・安全性試験ではありません。
リポジトリの原文
見出し、例、コード、表、リンク、参照画像を含む原文を表示しています。
Skill: okf-fs (Local Filesystem OKF Connector)
This skill produces and ingests OKF bundles documenting local directory tree structures and metadata, respecting .okfignore files.
Setup
The connector is written in Go and requires Go 1.24+ to build from source:
bash
# Install the published binary (Go 1.24+) — no clone needed:
go install github.com/xSAVIKx/okf-skills/skills/okf-fs@v0.1.0
# …or build from a clone of the repository:
cd skills/okf-fs
go build -o okf-fs .Commands
1. produce
Traverses the specified directory, ignores files matching .okfignore rules, reads description text from .okf-metadata.yaml, and outputs an OKF bundle.
bash
./okf-fs produce --dir <directory-to-document> --out <bundle-output-dir>Options:
--dir(string): The path to the local directory to document (required).--out(string): The path where the generated OKF bundle will be created (required).
2. ingest
Compares an OKF bundle with the target directory, checks for file existence and mismatches, and optionally syncs file descriptions back into .okf-metadata.yaml.
bash
./okf-fs ingest --dir <target-directory> --bundle <okf-bundle-dir> [--sync]Options:
--dir(string): The target directory to compare against (required).--bundle(string): The path to the OKF bundle to ingest (required).--sync(bool): If true, updates.okf-metadata.yamlat the directory root with the descriptions from the bundle.
3. Inspect the Schema (self-description)
Print a machine-readable JSON description of this skill's commands and flags (used by okf-mcp to expose the skill as an MCP tool):
bash
./okf-fs schema
