Codeck AGENTS.md

Repository instructions for Codeck, a macOS application and Swift package with shared document logic and an MCP server. Swift Package Manager is Apple's tool for building Swift projects and managing their code targets.

In plain words
What is it for?
Use them to build and test the Swift package, run the MCP server, format and lint code, and create or inspect the macOS app bundle.
Why use it?
They explain where source, tests, examples, resources, and generated build files belong, reducing confusion when changing or testing the project.

Instructions file for CodexOpenCode

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/lkuczborski/codeck/agents-md
Clone the repo
git clone --depth 1 https://github.com/lkuczborski/Codeck

Made for: Codex, OpenCode.

Per session 612 This file is loaded in full into every session.
When invoked 612 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00612 $0.00612
Opus 5 $0.00306 $0.00306
Sonnet 5 $0.00122 $0.00122
Haiku 4.5 $0.00061 $0.00061

Measured 2d ago against content hash 3eb8d17ab11a, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

Codeck AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 32 lines

How it starts

The opening of the file, as written. The whole thing — 32 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Repository Guidelines

Project Structure & Module Organization

Codeck is a Swift Package Manager project for macOS 14+. Source code lives in Sources/ and is split into three targets: Codeck for the native macOS app, CodeckCore for shared document and model logic, and CodeckMCP for the codeck-mcp executable. Tests live in Tests/CodeckTests. App and document icons are in Resources/, sample .mdeck decks are in Examples/, and the static site is in docs/. Generated build products belong in .build/ or dist/ and should not be committed.

Build, Test, and Development Commands

  • brew bundle: install local tools (swiftformat, swiftlint).
  • swift build: compile all package targets.
  • swift test: run the XCTest suite.
  • swift run codeck-mcp: run the file-based MCP server from the repository root.
  • script/format.sh: format Package.swift, Sources, and Tests.
  • script/lint.sh: run SwiftFormat lint mode and SwiftLint.
  • script/build_and_run.sh [run|--debug|--logs|--telemetry|--verify]: build an app bundle in dist/ and launch or inspect it.

Coding Style & Naming Conventions

Use Swift 6 conventions and keep code formatted by SwiftFormat. The root .swiftformat uses 4-space indentation, --maxwidth 160, preserved argument and collection wrapping, trimmed whitespace, and no semicolons. SwiftLint covers Package.swift, Sources, and Tests; notable rules include sorted imports, closure spacing, first(where:)/contains preferences, and line length warnings at 160 characters. Prefer clear Swift type names in UpperCamelCase and methods/properties in lowerCamelCase. Keep target-specific code inside its target directory.

Testing Guidelines

Tests use XCTest and are grouped by feature in Tests/CodeckTests, usually with filenames ending in Tests.swift. Name test methods descriptively, for example testParsesThemeAndSlideSeparatorsOutsideFences. Run swift test before submitting changes; add or update tests for parser behavior, document mutations, MCP protocol handling, and user-visible model logic.

Read the full file on GitHub · 32 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 32 lines · 612 tokens per session scan A 3eb8d17ab11a

Subscribe to this mod's changes

Codeck AGENTS.md is an instructions file published in the GitHub repository lkuczborski/Codeck (41 stars, last pushed 1mo ago), licensed MIT. It adds 612 tokens to every session, about $0.0031 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.