agentleFS
GitHubKnown publishergithub/squad/.copilot/skills/protected-files/SKILL.md

protected-files

Skill3.4k starsChanged 2 months agoMITView on GitHub

Zero-dependency bootstrap files that must never import npm packages or SDK code

The file

We split this skill into the rules it gives an agent

4 rules. About 0 are common, 2 are distinctive, and 2 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈2

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    When adding a new file that runs before SDK init:

    line 48
  2. Distinctive:

    Add it to the Protected File List table above

    line 49
  3. Very specific:

    Write a matching zero-dependency regression test (see detect-squad-dir-zero-deps.test.ts for the pattern)

    line 50
  4. Very specific:

    Add — zero dependencies marker in the file header

    line 51

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Context

The CLI (squad-cli) has bootstrap utilities that run before the Squad SDK is loaded. If these files import SDK code (e.g., FSStorageProvider, anything from squad-sdk), the CLI breaks at startup — no helpful error, just a crash.

This skill applies when:

  • Touching any file in packages/squad-cli/src/cli/core/
  • Running sweeping refactors (e.g., "convert all fs calls to StorageProvider")
  • Adding new bootstrap utilities

Protected File List

FilePurpose
packages/squad-cli/src/cli/core/detect-squad-dir.tsFinds .squad/ directory at startup — runs before SDK init
packages/squad-cli/src/cli/core/errors.tsError classes (SquadError, fatal()) — used by all CLI entry points
packages/squad-cli/src/cli/core/gh-cli.tsGitHub CLI wrapper — uses only node:child_process and node:util
packages/squad-cli/src/cli/core/output.tsColor/emoji console output — pure ANSI codes, zero imports
packages/squad-cli/src/cli/core/history-split.tsSeparates portable knowledge from project data — pure string logic

Rules

  • ❌ NEVER convert these files to use FSStorageProvider, StorageProvider, or any SDK abstraction
  • ❌ NEVER add import or require statements referencing packages outside node:* built-ins
  • ✅ ONLY use node:fs, node:path, node:child_process, node:util, and other Node.js built-in modules
  • ✅ DO check this list before sweeping refactors
  • ✅ LOOK for — zero dependencies markers in file headers as a signal

SDK/CLI Package Boundary

The packages/squad-cli/src/cli/core/ directory contains a mix of early-startup bootstrap utilities and later SDK-dependent modules. The protected list above is the authoritative set of zero-dependency bootstrap files. If you need to add SDK imports to another core/ file, verify it is not in the protected list and confirm the SDK is loaded at that point in the startup sequence.

Anti-Patterns

  • Converting all fs calls to StorageProvider without checking this list first
  • Adding import { X } from '@bradygaster/squad-sdk' to a bootstrap file
  • Assuming every file in core/ can safely import SDK code

Adding New Bootstrap Utilities

When adding a new file that runs before SDK init:

  1. Add it to the Protected File List table above
  2. Write a matching zero-dependency regression test (see detect-squad-dir-zero-deps.test.ts for the pattern)
  3. Add — zero dependencies marker in the file header

Regression tests guard these files, but prevention is better than detection.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

Reviews can't be read right now.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.