pinme AGENTS.md

Project instructions for PinMe, a command-line tool that deploys static websites to IPFS, a distributed system for storing and serving files. They describe the project, development commands, architecture, and important implementation patterns.

In plain words
What is it for?
Use it when building, testing, debugging, or modifying PinMe, especially its TypeScript CLI, esbuild build, IPFS deployment commands, and verification process.
Why use it?
Contributors need to know the correct build system, test commands, output files, and project conventions before changing the code.

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

Made for: Codex, OpenCode.

Per session 723 This file is loaded in full into every session.
When invoked 723 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.00723 $0.00723
Opus 5 $0.00362 $0.00362
Sonnet 5 $0.00145 $0.00145
Haiku 4.5 $0.00072 $0.00072

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

Security

Grade A, and why

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

Origin

Copies of this mod

1 near-identical copy found in the catalogue:

AGENTS.md · 52 lines

How it starts

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

AGENTS.md

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

Project Overview

PinMe is a zero-config CLI tool for deploying static sites to IPFS. Built with TypeScript, bundled with esbuild, published to npm as pinme. Users run commands like pinme upload dist to deploy frontends.

Build & Dev

npm run build          # Production build (esbuild → dist/index.js)
npm run dev            # Dev build
npm run test           # Unit/integration tests (Vitest)
npm run test:cli       # Real CLI black-box tests against dist/index.js
npm run verify         # Full PR gate: lint, typecheck, tests, build, CLI, pack
npm run test:mutation  # Slow mutation tests (manual/nightly)

Build uses build.js (esbuild), NOT rollup.config.js (legacy, unused). esbuild reads .env via dotenv at build time and injects env vars as process.env.* defines.

The output is a single CJS file at dist/index.js with a shebang, used as the pinme CLI binary.

Architecture

  • bin/index.ts — CLI entry point, uses commander to register all commands
  • bin/*.ts — Individual command implementations (upload, save, create, bind, importCar, exportCar, delete, etc.)
  • bin/utils/ — Shared utilities:
    • config.tsAPP_CONFIG singleton, all API base URLs and tuning knobs from env vars
    • apiClient.ts — Axios client factory (createPinmeApiClient, createCarApiClient)
    • pinmeApi.ts — High-level API wrappers (domain binding, wallet, CAR export, etc.)
    • uploadToIpfs.ts / uploadToIpfsSplit.ts — IPFS upload logic (single file vs chunked)
    • webLogin.ts — Auth token management (reads from ~/.pinme/)
    • domainValidator.ts — Domain name validation and DNS vs subdomain detection
    • cliError.ts — Structured CLI error types
  • bin/services/uploadService.ts — Upload orchestration (hash encryption, URL generation)
  • skills/ — Codex skill definitions for this project

Key Patterns

  • Auth: AppKey stored locally at ~/.pinme/. Auth headers injected via getAuthHeaders() in webLogin.ts.
  • API clients: Always use createPinmeApiClient() or createCarApiClient() from apiClient.ts, never raw axios.
  • Token expiry: pinmeApi.ts has centralized token-expired detection (isTokenExpired) — all API calls should go through wrappers there.
  • Config: All env-driven config lives in APP_CONFIG (config.ts). Don't read process.env directly elsewhere.
  • The save command reads pinme.toml from project root for full-stack deploy (frontend + Cloudflare Worker + D1).

Read the full file on GitHub · 52 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 · 52 lines · 723 tokens per session scan A 5e00bbd01634

Subscribe to this mod's changes

pinme AGENTS.md is an instructions file published in the GitHub repository glitternetwork/pinme (3,735 stars, last pushed 1mo ago), licensed MIT. It adds 723 tokens to every session, about $0.0036 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.