gorest AGENTS.md

gorest AGENTS.md is an instructions file for Codex, OpenCode from pilinux/gorest. It costs 5,194 tokens per session, scanned A, original, MIT.

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.

In plain words
What is it for?
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.
Why use it?
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.

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

agentmods badge for gorest AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/pilinux/gorest/agents-md.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.svg" alt="Measured on agentmods" height="20"></a>
Per session 5,194 This file is loaded in full into every session.
When invoked 5,194 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.05194 $0.05194
Opus 5 $0.02597 $0.02597
Sonnet 5 $0.01039 $0.01039
Haiku 4.5 $0.00519 $0.00519

Measured 5d ago against content hash 82a3587e228b, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, 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 5d 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 · 676 lines

How it starts

The opening of the file, as written. The whole thing — 676 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.25.0+ (go.mod declares go 1.25.0; CI tests against Go 1.25.x and 1.26.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.12.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

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)

Read the full file on GitHub · 676 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. 5d 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 (504 stars, last pushed today), licensed MIT. It adds 5,194 tokens to every session, about $0.0260 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.