agentleFS
metedatametedata/Remarc/AGENTS.md

Remarc

AGENTS.md73 starsChanged 3 months agoMITView on GitHub

macOS menu bar app (SwiftUI + AppKit) for contextual commenting on text selections. MANDATORY: After every successful build, you MUST relaunch Remarc. The user cannot verify changes otherwise. Do this every single time, no exceptions: 1. Build with -derivedDataPath "$(pwd)/DerivedData" (deterministic output path — no grep/find needed) 2. Relaunch: pkill -x Remarc; sleep 0.5; open app/DerivedData/Build/Products/Debug/Remarc.app When working on UI changes in SwiftUI, always do a clean build after layout changes to avoid stale build cache issues. Use xcodebuild clean…

  • Deletes or force-pushes
  • Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.

    Of the AGENTS.md files we read, the 31,439 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.

  • In this repository7 other files it gives its agents.

The file

We split this AGENTS.md into the rules it gives an agent

9 rules. About 0 are common, 4 are distinctive, and 5 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈4

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 5

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    When working on UI changes in SwiftUI, always do a clean build after layout changes to avoid stale build cache issues.

    line 17
  2. Distinctive:

    When building from worktrees, always verify the correct DerivedData path and binary location before launching.

    line 21
  3. Distinctive:

    When the user describes a UI bug, confirm WHICH specific component/view they mean before editing.

    line 25
  4. Very specific:

    Build path in worktrees: Always use "$(pwd)/DerivedData" (command substitution), never "$PWD/DerivedData" (variable) — $PWD can resolve …

    line 39
  5. Distinctive:

    When building from worktrees (or after nuking DerivedData), macOS TCC microphone permissions get fragmented across binary paths.

    line 43
  6. Very specific:

    All brand colors and gradients are defined in Views/Colors.swift as Color extensions.

    line 56
  7. Very specific:

    Quote references: use a 2pt indigo left border via .overlay(alignment: .leading) — keep this consistent across CommentCardView, …

    line 61
  8. Very specific:

    Buttons: use remarcBrandGradient for primary CTAs and remarcPrimary for accent text

    line 62
  9. Distinctive:

    When brainstorming features or writing implementation plans, always do online research (WebSearch, WebFetch) and check Context7 docs for …

    line 66

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

Remarc

macOS menu bar app (SwiftUI + AppKit) for contextual commenting on text selections.

  • Bundle ID: com.metepolat.Remarc
  • Min macOS: 14.0 (MACOSX_DEPLOYMENT_TARGET in app/Config/Shared.xcconfig is the source of truth), Swift 6.0+, LSUIElement (no dock icon)
  • Build: cd app && xcodebuild build -workspace Remarc.xcworkspace -scheme Remarc -configuration Debug -derivedDataPath "$(pwd)/DerivedData"
  • Debug log: /tmp/remarc_debug.log (Debug builds only; release builds write no log file unless defaults write com.metepolat.Remarc debugFileLoggingEnabled -bool YES)
  • Data: ~/Library/Application Support/Remarc/comments.json (legacy fallback: data.json)

MANDATORY: After every successful build, you MUST relaunch Remarc. The user cannot verify changes otherwise. Do this every single time, no exceptions:

  1. Build with -derivedDataPath "$(pwd)/DerivedData" (deterministic output path — no grep/find needed)
  2. Relaunch: pkill -x Remarc; sleep 0.5; open app/DerivedData/Build/Products/Debug/Remarc.app

Build

When working on UI changes in SwiftUI, always do a clean build after layout changes to avoid stale build cache issues. Use xcodebuild clean or delete DerivedData when builds behave unexpectedly.

Worktree Builds

When building from worktrees, always verify the correct DerivedData path and binary location before launching. Use absolute paths instead of $PWD in build commands.

UI Work

When the user describes a UI bug, confirm WHICH specific component/view they mean before editing. Ask clarifying questions if the target is ambiguous (e.g., 'comment cards' vs 'session chips').

Development

Contribution Attribution

Use Mete Polat <20049378+metedata@users.noreply.github.com> as the author of repository and automated release commits and as the tagger of annotated tags. Automated commits must use the same identity as committer. Do not add Co-authored-by or equivalent attribution for bots, models, agents, or anyone else. Attribute another contributor only when Mete explicitly requests it.

Git Worktrees — MANDATORY

All code changes MUST be made in a git worktree, not on main. Always create a worktree before starting any feature, bugfix, or refactor. The only exceptions are edits to root config files (AGENTS.md, scripts/, .Codex/).

Worktrees go in .worktrees/ (gitignored). Use git worktree add .worktrees/<name> -b <branch> for isolated feature work.

Build path in worktrees: Always use "$(pwd)/DerivedData" (command substitution), never "$PWD/DerivedData" (variable) — $PWD can resolve incorrectly in subshells and worktree contexts.

Crit Mode / Microphone Capture

When building from worktrees (or after nuking DerivedData), macOS TCC microphone permissions get fragmented across binary paths. The audio tap silently produces 0 buffers without any error. Fix: nuke DerivedData + reset TCC before relaunch:

rm -rf app/DerivedData
# rebuild...
tccutil reset Microphone com.metepolat.Remarc
pkill -x Remarc; sleep 0.5; open app/DerivedData/Build/Products/Debug/Remarc.app

The user must grant mic access when macOS prompts after the reset. Do this whenever audio capture stops working (0 buffers in debug log).

Color System

All brand colors and gradients are defined in Views/Colors.swift as Color extensions. When making color-related changes:

  • Use remarc* tokens (remarcPrimary, remarcSecondary, remarcAccent, etc.) — never hardcode brand hex values in views
  • All tokens take colorScheme — they adapt for light/dark mode automatically
  • Popover background uses remarcBackgroundGradient(for:) — layered EllipticalGradients with .plusLighter blend over a darkened base. Do not add .background(.regularMaterial) to SwiftUI — the VEV provides that
  • Quote references use a 2pt indigo left border via .overlay(alignment: .leading) — keep this consistent across CommentCardView, CommentEditorView, and CommentInputView
  • Buttons use remarcBrandGradient for primary CTAs and remarcPrimary for accent text

Research During Brainstorming & Planning

When brainstorming features or writing implementation plans, always do online research (WebSearch, WebFetch) and check Context7 docs for relevant Apple frameworks and libraries before proposing approaches. API availability, deprecation status, and permission requirements change frequently — don't rely on training data alone.

Architecture

  • app/RemarcPackage/ — Swift Package with all app source
  • app/RemarcPackage/Sources/RemarcFeature/ — Main feature module
    • Views/ — SwiftUI views and AppKit window controllers
    • Services/ — PersistenceManager, SelectionMonitor, ExportManager, etc.
  • scripts/ — Automation scripts
  • tools/ax-inspect/ — Accessibility inspection CLI (standalone SPM package)

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.