What is gorest AGENTS.md?

Repository instructions for coding agents working on pilinux/gorest, a Go REST API starter project. They describe the project structure, required Go versions, commands, testing setup, and code-quality checks.

Use them when changing or reviewing this repository, especially before running builds, tests, dependency cleanup, formatting, vetting, or linters. They also help an agent find the relevant project areas and commands.

They give an agent the project-specific rules needed to build, test, format, inspect, and lint the code correctly. They also explain required test environment variables and cross-platform checks.

How pilinux/gorest configures Codex and OpenCode

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/AGENTS.md

Clone the repo

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

Made for: Codex, OpenCode.

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/agents-md/github.svg)](https://agentmods.dev/instructions/pilinux/gorest/agents-md)

Your own site

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

Per session 6,700 This file is loaded in full into every session.

When invoked 6,700 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.06700	$0.06700
Opus 5.5	$0.02680	$0.02680
Sonnet 5.5	$0.01340	$0.01340
Haiku 4.5	$0.00670	$0.00670

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

Security

Grade A, and why

gorest 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 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.

AGENTS.md · 769 lines

How it starts

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

AGENTS.md

Instructions for AI coding agents working in this repository.

Project Overview

Go RESTful API starter kit built with Gin, GORM, JWT, Redis, MongoDB, 2FA, email verification, and password recovery. Module path: github.com/pilinux/gorest. Requires Go 1.26.0+ (go.mod declares go 1.26.0; CI tests against Go 1.26.x and 1.27.x).

Build and Run Commands

Build

go build -v ./...

Tidy Dependencies

go mod tidy

Format

go fmt ./...

Vet

go vet -v ./...

Lint

golangci-lint run ./...
revive ./...

CI uses golangci-lint v2.13.2 with --timeout 5m --verbose.

Test - All

go test -v -cover ./...

Test - Single Package

go test -v -cover ./lib/...
go test -v -cover ./config/...

Test - Single Test Function

go test -v -run TestHashPass ./lib/...
go test -v -run TestFirewall ./lib/middleware/...

Test Environment

Tests require environment variables. In CI these come from secrets. Locally, source setTestEnv.sh before running tests:

source setTestEnv.sh

example3/ is the exception: its tests use in-memory fakes for both Mongo interfaces, so go test ./example3/... needs neither env vars nor a live database.

Cross-Platform Vet (CI runs all six)

GOOS=linux GOARCH=amd64 go vet -v ./...
GOOS=darwin GOARCH=arm64 go vet -v ./...

Project Structure

config/ - Configuration loading from .env files
controller/ - HTTP request handlers (thin layer, calls handler)
handler/ - Business logic layer (called by controller)
service/ - Utility services (auth, security, email)
database/ - DB connection management and models
database/model/ - Shared data models (Auth, HTTPResponse)
database/migrate/ - GORM auto-migration
lib/ - Core utility library (hashing, encryption, validation)
lib/middleware/ - Gin middleware (JWT, CORS, firewall, rate limit)
lib/renderer/ - HTTP response rendering (JSON and HTML)
lib/server/ - Graceful server shutdown
example/ - Legacy example app
example2/ - Recommended example app (interface-driven, DI)
example3/ - Envelope-encryption example app (MongoDB-only, interface-driven)

Read the full file on GitHub · 769 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 · +23 lines · +417 tokens per session 590f53b9db99
1mo ago Changed · +70 lines · +1,089 tokens per session 6ec03308ed25
2mo ago First seen · 676 lines · 5,194 tokens per session scan A 82a3587e228b

Subscribe to this mod's changes

gorest AGENTS.md is an instructions file published in the GitHub repository pilinux/gorest (506 stars, last pushed 16d ago), licensed MIT. It adds 6,700 tokens to every session, about $0.0268 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 api go rest-api restful restful-api

gorest AGENTS.md next to 6 instructions from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
gorest AGENTS.mdpilinux/gorest	Instructions file	506	16d ago	MIT	A	6,700	Codex, OpenCode
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 Codex