go-rest-api-boilerplate: Instructions file for Codex

AGENTS.md

go-rest-api-boilerplate AGENTS.md is an instructions file for Codex, OpenCode from vahiiiid/go-rest-api-boilerplate. It costs 4,878 tokens per session, scanned A, a copy of go-rest-api-boilerplate copilot-instructions.md, MIT.

Project instructions for GRAB, a Go starter project for building web APIs. They describe its tools, code structure, testing, database, Docker workflow, and authentication setup.

In plain words
What is it for?
Use them when asking an agent to develop, test, configure, or understand the GRAB Go REST API project.
Why use it?
They give a coding agent the project context and working rules needed to make changes that fit the existing application.

Instructions file for CodexOpenCode

Written for Codex and OpenCode: the file is AGENTS.md. Also seen: mentions CLAUDE.md; mentions Claude Code; mentions AGENTS.md.

This is vahiiiid/go-rest-api-boilerplate's own configuration. It tells Codex and OpenCode how to work on go-rest-api-boilerplate itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything go-rest-api-boilerplate configures โ†’

Reuse

Borrowing it

Nothing to install: this file belongs to vahiiiid/go-rest-api-boilerplate. 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/vahiiiid/go-rest-api-boilerplate/main/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/vahiiiid/go-rest-api-boilerplate

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 go-rest-api-boilerplate AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/vahiiiid/go-rest-api-boilerplate/agents-md/github.svg)](https://agentmods.dev/instructions/vahiiiid/go-rest-api-boilerplate/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/vahiiiid/go-rest-api-boilerplate/agents-md"><img src="https://agentmods.dev/badge/instructions/vahiiiid/go-rest-api-boilerplate/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.

agentmods 80ร—15 button for go-rest-api-boilerplate AGENTS.md

Your own site ยท 80ร—15
<a href="https://agentmods.dev/instructions/vahiiiid/go-rest-api-boilerplate/agents-md"><img src="https://agentmods.dev/badge/instructions/vahiiiid/go-rest-api-boilerplate/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 4,878 This file is loaded in full into every session.
When invoked 4,878 The same file โ€” it is already loaded in full.
Security scan A 1 finding. A grade says what 26 rules found in the file โ€” not that it is safe.
Origin 88% copy Near-identical to another mod 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.1 $0.04878 $0.04878
Opus 5 $0.02439 $0.02439
Sonnet 5 $0.00976 $0.00976
Haiku 4.5 $0.00488 $0.00488

Measured 9d ago against content hash 1f33a2cdcf4f, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-09, from the pricing page.

Security

Grade A, and why

go-rest-api-boilerplate AGENTS.md scanned grade A with 1 finding 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 9d 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.

Makes network callslowCapability

Not a fault in itself. Listed so you know the mod talks to something, and to what.

| Health check | `curl localhost:8080/health` |
Origin

This is a copy

88% identical to go-rest-api-boilerplate copilot-instructions.md โ€” 889 lines differ, which has more behind it and is treated as the original. This page carries a canonical link to it rather than competing with it.

AGENTS.md ยท 649 lines

How it starts

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

GRAB - AI-Friendly Development Guide

Version: v2.0.0
Last Updated: 2025-12-10
Purpose: Universal AI assistant guidelines for GRAB (Go REST API Boilerplate)

This file follows the AGENTS.md standard (stewarded by the Agentic AI Foundation) and is compatible with all major AI coding assistants including GitHub Copilot, Cursor, Windsurf, Claude Code, JetBrains AI, and others.

This is the canonical source of truth for GRAB's AI guidelines. Claude Code reads it via CLAUDE.md's @AGENTS.md import; Copilot, Cursor, and Windsurf each keep a condensed, manually-synced adapter. See .agents/AI-CONFIG.md for the full file map and the rule for keeping them in sync.


๐Ÿ“‹ Project Overview

GRAB (Go REST API Boilerplate) is a production-ready Go REST API starter with Clean Architecture, comprehensive testing (89.81% coverage), and Docker-first development workflow.

Technology Stack

  • Go: Check version with go version
  • Gin: HTTP router framework
  • GORM: PostgreSQL ORM
  • PostgreSQL: Check version with make exec-db then psql --version
  • Docker: Check version with docker --version
  • golang-migrate: Database migration tool
  • JWT: Authentication with refresh token rotation
  • Air: Hot-reload development
  • golangci-lint: Code quality enforcement
  • Swagger: OpenAPI documentation

Documentation


๐Ÿ—๏ธ Architecture

Clean Architecture Pattern

GRAB strictly follows Clean Architecture with clear layer separation:

Handler (HTTP) โ†’ Service (Business Logic) โ†’ Repository (Database)

Domain Structure:

internal/<domain>/
โ”œโ”€โ”€ model.go       # GORM models with database tags
โ”œโ”€โ”€ dto.go         # Data Transfer Objects (API contracts)
โ”œโ”€โ”€ repository.go  # Database access interface + implementation
โ”œโ”€โ”€ service.go     # Business logic interface + implementation
โ”œโ”€โ”€ handler.go     # HTTP handlers with Gin + Swagger annotations
โ””โ”€โ”€ *_test.go      # Unit and integration tests

Read the full file on GitHub ยท 649 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. 9d ago First seen ยท 649 lines ยท 4,878 tokens per session scan A 1f33a2cdcf4f

Subscribe to this mod's changes

go-rest-api-boilerplate AGENTS.md is an instructions file published in the GitHub repository vahiiiid/go-rest-api-boilerplate (66 stars, last pushed 22d ago), licensed MIT. It adds 4,878 tokens to every session, about $0.0244 per session on Opus 5. A static security scan graded it A with 1 finding (makes network calls). It is 88% identical to go-rest-api-boilerplate copilot-instructions.md, differing in 889 lines, and is treated as a copy.

Related

Other instructions, from other repositories

klaussy-agents fastapi.instructions.md

Instructions for steph-dove/klaussy-agents: Example context from fastapi/applications.py (lines 214-220).

steph-dove/klaussy-agents ยท 1,171 tokens

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js ยท 7,296 tokens

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex ยท 5,153 tokens

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode ยท 6,785 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode ยท 5,001 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain ยท 4,469 tokens