# Okf Fs

> Local filesystem connector that produces and ingests Open Knowledge Format (OKF) bundles documenting directory trees and file metadata, honoring .okfignore and .okf-metadata.yaml. Use when documenting or cataloging a local folder structure, or capturing filesystem metadata as an OKF bundle.

- **Type:** Skill
- **Install:** `agentstack add skill-xsavikx-okf-skills-okf-fs`
- **Verified:** Yes — security-reviewed for prompt injection and unsafe behavior
- **Seller:** [xSAVIKx](https://agentstack.voostack.com/s/xsavikx)
- **Installs:** 0
- **Category:** [Agent Skills](https://agentstack.voostack.com/c/agent-skills)
- **Latest version:** 0.1.0
- **License:** Apache-2.0
- **Upstream author:** [xSAVIKx](https://github.com/xSAVIKx)
- **Source:** https://github.com/xSAVIKx/okf-skills/tree/master/skills/okf-fs
- **Website:** https://xsavikx.github.io/okf-skills/

## Install

```sh
agentstack add skill-xsavikx-okf-skills-okf-fs
```

Requires the [AgentStack CLI](https://agentstack.voostack.com/docs/cli). Works with Claude Code, Cursor, and any MCP-compatible agent.

## About

# 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  --out 
```

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  --bundle  [--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.yaml` at 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
```

## Source & license

This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.

- **Author:** [xSAVIKx](https://github.com/xSAVIKx)
- **Source:** [xSAVIKx/okf-skills](https://github.com/xSAVIKx/okf-skills)
- **License:** Apache-2.0
- **Homepage:** https://xsavikx.github.io/okf-skills/

Install and usage instructions live in the source repository linked above.

## Pricing

- **Free** — Free

## Security capabilities

Automated source analysis of v0.1.0 — what this tool can access:

- **Network access:** no
- **Filesystem access:** no
- **Shell / process execution:** no
- **Environment & secrets:** no
- **Dynamic code execution:** no

*"Yes" means the capability is present in the source — more access means more to trust, not that it is unsafe.*


## Versions

- **0.1.0** — security scan: passed — Imported from the upstream source.

## Links

- Listing page: https://agentstack.voostack.com/l/skill-xsavikx-okf-skills-okf-fs
- Seller: https://agentstack.voostack.com/s/xsavikx
- Browse the marketplace: https://agentstack.voostack.com/browse

---
Listed on AgentStack — the marketplace for AI agent skills and MCP servers. Every listing is security-reviewed. Creators keep 70%.