Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: ci
on:
push:
pull_request:
permissions:
contents: read
jobs:
selftest:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: '3.12'
- run: python -m pip install pyyaml
- run: bash scripts/selftest.sh
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2026 Edward Becker <edward.becker@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
9 changes: 9 additions & 0 deletions NOTICE
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
OKF skill
Copyright (c) 2026 Edward Becker

This repository is licensed under the MIT License (see LICENSE), except as noted below.

references/spec.md is a vendored copy of the Open Knowledge Format specification
from https://github.com/GoogleCloudPlatform/knowledge-catalog/blob/ee67a5ca27044ebe7c38385f5b6cffc2305a9c1a/okf/SPEC.md
by the GoogleCloudPlatform/knowledge-catalog contributors, licensed under the
Apache License, Version 2.0: https://www.apache.org/licenses/LICENSE-2.0
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,22 +13,27 @@ Embedding commands also need Ollama or an API key for the selected provider.

## Install

Overdeck users receive this skill through `pan sync`.
[eltmon/okf](https://github.com/eltmon/okf) is the canonical home of this skill. Releases are git tags named `vX.Y.Z`.

Standalone Claude Code users install it from the mirror repo, [eltmon/okf](https://github.com/eltmon/okf) — symlink so `git pull` updates it in place:
**With Overdeck.** Overdeck vendors one release tag (recorded in its `sync-sources/skills/okf/.okf-skill-version`), and `pan sync` installs it into `~/.claude/skills/okf` (Claude Code) and `~/.agents/skills/okf` (Codex, Pi). Do not edit those copies: `pan sync` replaces local edits, and `pan doctor` warns when an installed copy's version differs from the vendored one. Change the skill here, tag a release, and re-vendor it in Overdeck.

**Standalone Claude Code.** Clone the repo and symlink it so `git pull` updates it in place:

```bash
git clone https://github.com/eltmon/okf.git ~/Projects/okf
mkdir -p ~/.claude/skills
ln -s ~/Projects/okf ~/.claude/skills/okf
```

Or copy-install instead of symlinking:
**Standalone Codex or Pi.** Both read the shared Agent Skills directory:

```bash
cp -R ~/Projects/okf ~/.claude/skills/okf
mkdir -p ~/.agents/skills
ln -s ~/Projects/okf ~/.agents/skills/okf
```

To pin a release, run `git -C ~/Projects/okf checkout vX.Y.Z`. If you also run Overdeck on the same machine, skip the symlinks and let `pan sync` manage the copies.

The skill remains portable. Its core scripts do not import Overdeck and require only git, gh, Python 3, and PyYAML for non-embedding workflows.

## 5-Minute Quickstart
Expand Down
Loading