agentleFS
nikshipsnikships/skills-registry/AGENTS.md

skills-registry

AGENTS.md25 starsChanged 6 months agoApache-2.0View on GitHub

skills-registry has four user-facing surfaces: From cli/ run: Go naming follows standard conventions: short lowercase packages, PascalCase exports, camelCase unexported names, and preserved initialisms such as URL, SHA, and ID. Native macOS jobs and Darwin release builds use the dedicated Aqua-session self-hosted runner labeled mac-mini; Linux, Windows, and untrusted fork jobs remain on GitHub-hosted runners. Follow .github/AGENTS.md for runner and signing operations. When changing user-visible behavior, update README.md and docs/registry.md. Add or update focused tests, avoid new mandatory runtime dependencies…

  • 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 33,315 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 repository6 other files it gives its agents.

The file

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

1 rule. About 0 are common, 0 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

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

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

    When changing user-visible behavior, update README.md and docs/registry.md.

    line 40

≈ “Common” is an estimate: at least 1 in 5 of the 42,283 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

Repository guidance

skills-registry has four user-facing surfaces:

SurfaceDistributionRole
Installers and npm wrapperinstall.sh, install.ps1, and npx skills-registryDownload and launch the matching release binary.
Go CLIGitHub Release binariesCharmbracelet TUI and headless registry commands.
macOS appSigned and notarized SwiftUI appNative GUI for the same registry and configuration.
WebsiteStatic Next.js siteProject landing page and product documentation.

Layout and contracts

  • cli/ is the Go module. Bare invocation opens the seven-step onboarding wizard when configuration is missing and the dashboard otherwise. Headless commands are bootstrap, list, search, get, sync, add, publish, remove, and update; all honor --json.
  • The wizard scans local skills, chooses a repository and visibility, performs the bulk push, installs the gateway skill, optionally cleans up local copies, and finishes with the registry URL. bootstrap likewise ends with the registry URL and does not print client configuration.
  • The generated skills-registry/SKILL.md gateway is CLI-only: agents use skills-registry search, get, and other commands rather than a separate service.
  • Configuration lives at ~/.config/skills-registry/registry.toml (or $XDG_CONFIG_HOME/skills-registry/registry.toml). Cache and mirrors live under ~/.cache/skills-registry/ (or $XDG_CACHE_HOME/skills-registry/).
  • mac-app/ is the Swift package and app. Keep shared slug, frontmatter, fuzzy-search, GitHub-write, configuration, and gateway-template behavior aligned with the CLI.
  • npm/ is a thin launcher; it must not commit or bundle release binaries.
  • website/ is the static project site.
  • .mcpjam/ is a supported agent directory. Keep MCPJam agent discovery support even though the project does not ship an MCP service.

Build and test

From cli/ run:

go vet ./...
gofmt -l .
staticcheck ./...
deadcode -test ./...
gocyclo -over 15 -ignore "_test" .
go test ./...

Go naming follows standard conventions: short lowercase packages, PascalCase exports, camelCase unexported names, and preserved initialisms such as URL, SHA, and ID.

Native macOS jobs and Darwin release builds use the dedicated Aqua-session self-hosted runner labeled mac-mini; Linux, Windows, and untrusted fork jobs remain on GitHub-hosted runners. Follow .github/AGENTS.md for runner and signing operations.

When changing user-visible behavior, update README.md and docs/registry.md. Add or update focused tests, avoid new mandatory runtime dependencies without justification, and use conventional-commit prefixes (feat:, fix:, docs:, refactor:, test:, chore:).

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.