artifact-fs AGENTS.md

A set of repository-specific instructions for the artifact-fs project. It documents code-review rules, system structure, runtime expectations, and coding conventions for working on the project.

In plain words
What is it for?
Use it when reviewing or changing artifact-fs code, especially its command-line entry point, repository lifecycle, virtual filesystem, Git storage, and path handling.
Why use it?
It gives an coding agent the project context needed to avoid breaking important rules, such as exposing credentials, mishandling binary data, or bypassing canonical interfaces.

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

Made for: Codex, OpenCode.

Per session 821 This file is loaded in full into every session.
When invoked 821 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.00821 $0.00821
Opus 5 $0.00411 $0.00411
Sonnet 5 $0.00164 $0.00164
Haiku 4.5 $0.00082 $0.00082

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

Security

Grade A, and why

artifact-fs 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 · 47 lines

How it starts

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

AGENTS.md

Repository-specific guidance for artifact-fs.

Code review rules

  • Flag credentials in Git CLI arguments or unredacted logs. Pass credentials through the environment-based helper in internal/gitstore/gitstore.go, and redact log output with auth.RedactString.
  • Flag blob bytes converted to string. Keep BlobToCache binary-safe by streaming git cat-file --batch output to disk.
  • Keep GIT_NO_LAZY_FETCH=1 on git cat-file --batch-check in batchResolveSizes. Removing it turns size resolution in blobless clones into network round-trips.
  • Normalize paths only with model.CleanPath(). Do not add local wrappers.
  • Use the canonical model.* interfaces for snapshot, overlay, hydrator, and gitstore access. Do not add subset interfaces around them.

Architecture

  • cmd/artifact-fs is the only binary entrypoint.
  • internal/cli wires commands onto daemon.Service.
  • internal/daemon owns repo lifecycle: registry sync, snapshot publish, overlay reconcile, FUSE mount, watcher, refresh loop.
  • internal/fusefs is the merged view and writable filesystem layer.
  • internal/gitstore is the performance-sensitive git wrapper; most easy-to-break invariants live there.
  • internal/snapshot and internal/overlay are persistent SQLite-backed stores.

Runtime contracts

  • ARTIFACT_FS_ROOT is the state root. artifact-fs daemon --root is the mount root. They are different things.
  • add-repo is one-shot by default: register repo, clone blobless, build the initial snapshot, then exit. It does not mount FUSE or start background goroutines.
  • add-repo --async only registers prepare state. The daemon mounts a gated placeholder, prepares clone/fetch and snapshot in the background, then opens the gate and starts watcher/refresh.
  • daemon is long-running: it mounts registered repos and starts watcher, refresh, and hydrator workers.
  • git.CloneBlobless already populates the git index with read-tree HEAD; be careful about extra index resets because they can discard staged state.

Read the full file on GitHub · 47 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 · 47 lines · 821 tokens per session scan A 6a50da478d04

Subscribe to this mod's changes

artifact-fs AGENTS.md is an instructions file published in the GitHub repository cloudflare/artifact-fs (1,129 stars, last pushed 21d ago), licensed Apache-2.0. It adds 821 tokens to every session, about $0.0041 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.