gitprofile AGENTS.md

Repository instructions for GitProfile, a portfolio website template that reads a person's public GitHub profile and repositories. Customization is mainly done through one configuration file before deploying to GitHub Pages.

In plain words
What is it for?
Use it to customize names, links, jobs, skills, and projects, configure a GitHub username, and prepare the portfolio for its deployment address.
Why use it?
It prevents common setup mistakes, especially an incorrect base path that can make the deployed site lose its styles and scripts.

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/arifszn/gitprofile/agents-md
Clone the repo
git clone --depth 1 https://github.com/arifszn/gitprofile

Made for: Codex, OpenCode.

Per session 1,201 This file is loaded in full into every session.
When invoked 1,201 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.01201 $0.01201
Opus 5 $0.00600 $0.00600
Sonnet 5 $0.00240 $0.00240
Haiku 4.5 $0.00120 $0.00120

Measured 2d ago against content hash e2279446cde9, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

gitprofile 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 2d 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 · 83 lines

How it starts

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

AGENTS.md

Guidance for AI coding agents working in this repository.

What this project is

GitProfile is a fork-first portfolio template. It builds a portfolio site from a GitHub username: the profile, avatar, bio and repositories are fetched from the public GitHub API at runtime, so there is no database and no backend.

Most people arrive here by forking the repo and deploying it to GitHub Pages. Assume that is the task unless told otherwise.

Customizing a portfolio: edit one file

gitprofile.config.ts is the only file that needs to change to customize a portfolio. Do not edit anything under src/ to change someone's name, links, jobs, skills or projects — every one of those is a config value.

github.username is the only required option. Every other section can be left empty or as an empty array, which hides that section from the rendered page.

The base option is the most common source of breakage

base must match the deployment target, or the site builds fine and then loads without CSS or JavaScript:

  • Deploying to https://<USERNAME>.github.iobase: '/'
  • Deploying to https://<USERNAME>.github.io/<REPO_NAME>base: '/<REPO_NAME>/' (leading and trailing slash)
  • Deploying to Vercel, Netlify or a custom domain → base: '/'

It is read by vite.config.ts, not by the React app, so a change to it only takes effect on rebuild. Note that base is deliberately absent from the SanitizedConfig interface for this reason.

Layout

Path What lives there
gitprofile.config.ts All user-facing configuration
src/components/gitprofile.tsx Root component; GitHub API calls and data fetching
src/components/*/ One folder per portfolio section (avatar, skills, experience, …)
src/interfaces/sanitized-config.tsx The config schema, as TypeScript interfaces
src/utils/index.tsx getSanitizedConfig() — applies defaults and validates config
src/constants/default-themes.tsx The list of selectable themes
src/assets/index.css Tailwind and daisyUI setup, plus custom themes

Read the full file on GitHub · 83 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. 2d ago First seen · 83 lines · 1,201 tokens per session scan A e2279446cde9

Subscribe to this mod's changes

gitprofile AGENTS.md is an instructions file published in the GitHub repository arifszn/gitprofile (2,302 stars, last pushed yesterday), licensed MIT. It adds 1,201 tokens to every session, about $0.0060 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.