From 4c41935b831276f0b5f53cd29a7d3b62a5880c6d Mon Sep 17 00:00:00 2001 From: Edward Becker Date: Tue, 29 Sep 2026 10:47:56 -0400 Subject: [PATCH 1/3] chore: add MIT LICENSE and Apache-2.0 NOTICE for the vendored spec --- LICENSE | 21 +++++++++++++++++++++ NOTICE | 9 +++++++++ 2 files changed, 30 insertions(+) create mode 100644 LICENSE create mode 100644 NOTICE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..9a7b3d4 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 Edward Becker + +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. diff --git a/NOTICE b/NOTICE new file mode 100644 index 0000000..c43d653 --- /dev/null +++ b/NOTICE @@ -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 From fc3b99cc9a64ef5f543cbcd7ea55dc8f68210645 Mon Sep 17 00:00:00 2001 From: Edward Becker Date: Tue, 29 Sep 2026 10:49:14 -0400 Subject: [PATCH 2/3] ci: run scripts/selftest.sh on push and pull_request --- .github/workflows/ci.yml | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 .github/workflows/ci.yml diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..5d34565 --- /dev/null +++ b/.github/workflows/ci.yml @@ -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 From c6833ae00cc90f8bb7bc95baff060e8355c4f59d Mon Sep 17 00:00:00 2001 From: Edward Becker Date: Tue, 29 Sep 2026 10:50:39 -0400 Subject: [PATCH 3/3] docs: canonical-repo install section for Claude Code, Codex and Pi --- README.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4a1e120..d5ce57d 100644 --- a/README.md +++ b/README.md @@ -13,9 +13,11 @@ 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 @@ -23,12 +25,15 @@ 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