What is gorest CLAUDE.md?

Repository instructions for coding agents working on pilinux/gorest, a Go REST API starter project. They identify the authoritative project documents, common commands, architecture guidance, and files containing secrets or generated noise.

Use them when navigating, modifying, testing, or reviewing this repository. They are particularly useful for understanding which references to read, which files to avoid, and which commands to run.

They help agents find the right documentation and avoid opening or changing sensitive files. They also provide the project rules needed before making code changes.

How pilinux/gorest configures Claude Code

Reuse

Borrowing it

Nothing to install: this file belongs to pilinux/gorest. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file

curl -O https://raw.githubusercontent.com/pilinux/gorest/main/CLAUDE.md

Clone the repo

git clone --depth 1 https://github.com/pilinux/gorest

Made for: Claude Code.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/pilinux/gorest/claude-md/github.svg)](https://agentmods.dev/instructions/pilinux/gorest/claude-md)

Your own site

<a href="https://agentmods.dev/instructions/pilinux/gorest/claude-md"><img src="https://agentmods.dev/badge/instructions/pilinux/gorest/claude-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

Your own site · 80×15

<a href="https://agentmods.dev/instructions/pilinux/gorest/claude-md"><img src="https://agentmods.dev/badge/instructions/pilinux/gorest/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 1,388 This file is loaded in full into every session.

When invoked 1,388 The same file — it is already loaded in full.

Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.

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.

Model	Per session	Once invoked
Fable 5.1	$0.01388	$0.01388
Opus 5.5	$0.00555	$0.00555
Sonnet 5.5	$0.00278	$0.00278
Haiku 4.5	$0.00139	$0.00139

Measured 1mo ago against content hash 5b93f947d6a0, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

gorest CLAUDE.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 1mo 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.

CLAUDE.md · 104 lines

How it starts

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

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Authoritative references

This repo already ships detailed agent docs. Read these before making changes; they are the source of truth and far more complete than this file:

AGENTS.md: build/lint/test commands, code style, import aliases, layer responsibilities, controller↔handler 1:1 map, config/db/middleware/service APIs.
llms.txt: machine-readable interface describing repo purpose, capabilities, and constraints.
.agents/skills/<name>/SKILL.md: task-specific workflow guides (test-runner, ci-orchestrator, migration-helper, config-loader-helper, etc.).

Files to NEVER read or modify

Per .gitignore (and AGENTS.md), these contain secrets, keys, or generated noise. Do not open, read, or edit them:

.env and any *.log (includes log.txt), *.bak
keys/, tmp/, .build/, .vscode/, vendor/
coverage.txt, coverage_0.txt
pri*key*.pem, pub*key*.pem
crosscompile*.sh

Common commands

source setTestEnv.sh                           # required before running tests locally
go test -v -cover ./...                        # all tests
go test -v -run TestHashPass ./lib/...         # single test function
golangci-lint run ./...                        # lint (CI uses v2.13.2, --timeout 5m)
go vet -v ./... && go build -v ./...           # vet + build

CI additionally runs gosec, govulncheck, and cross-platform go vet/build across linux/darwin/windows × amd64/arm64. Tests need env vars (CI uses secrets; locally setTestEnv.sh), except go test ./example3/..., which fakes its Mongo interfaces and needs neither env vars nor a live database.

Architecture (the big picture)

gorest is a reusable Go module (github.com/pilinux/gorest), not just an app. It is both a library of auth/crypto/middleware/db primitives and three example apps that wire them together. Requires Go 1.26.0+ (go.mod declares go 1.26.0; CI tests against Go 1.26.x and 1.27.x).

Read the full file on GitHub · 104 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.

1mo ago Changed · +4 lines · +83 tokens per session 5b93f947d6a0
1mo ago Changed · +12 lines · +226 tokens per session 13e43563ba43
2mo ago First seen · 88 lines · 1,079 tokens per session scan A 4f5d39605338

Subscribe to this mod's changes

gorest CLAUDE.md is an instructions file published in the GitHub repository pilinux/gorest (506 stars, last pushed 16d ago), licensed MIT. It adds 1,388 tokens to every session, about $0.0056 per session on Opus 5.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.

Go Planning api go rest-api restful restful-api

gorest CLAUDE.md next to 6 instructions from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
gorest CLAUDE.mdpilinux/gorest	Instructions file	506	16d ago	MIT	A	1,388	Claude Code
vscode buildNext.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	9,719	GitHub Copilot
next.js AGENTS.mdvercel/next.js	Instructions file	143k	yesterday	MIT	A	7,461	Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchain	Instructions file	149k	yesterday	MIT	A	4,680	Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	5,516	GitHub Copilot
vscode copilot-instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	3,093	GitHub Copilot
deepseek-harness AGENTS.mddeepseek-ai/deepseek-harness	Instructions file	274k	2d ago	MIT	A	4,313	Codex, OpenCode

gorest: Instructions file for Claude Code