agentleFS
Sign inStart free
natsustannatsustan/skdeck/AGENTS.md

skdeck

AGENTS.md1 starsChanged 3 months agoMITView on GitHub

src/cli.tsx is the executable entry point. Command handlers live in src/commands/, reusable interactive prompts in src/prompts/, and storage, planning, validation, hashing, and GitHub operations in src/core/. The Ink/React interface is split between src/tui/screens/, reusable src/tui/components/, and shared state in src/tui/state.ts. Tests live in test/: core lifecycle coverage is in core.integration.test.ts, GitHub URL parsing in github.test.ts, and rendered/interactive terminal behavior in tui.test.tsx. Build output goes to dist/ and should not be hand-edited. Use TypeScript/TSX with two-space indentation, single quotes, semicolons, and…

  • Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.

    Of the AGENTS.md files we read, the 31,542 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.

  • In this repository2 other files it gives its agents.

The file

We split this AGENTS.md into the rules it gives an agent

1 rule. About 0 are common, 0 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    No formatter or linter is configured, so match nearby code and run pnpm typecheck before submitting.

    line 19

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md 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
AGENTS.md

Repository Guidelines

Project Structure & Module Organization

src/cli.tsx is the executable entry point. Command handlers live in src/commands/, reusable interactive prompts in src/prompts/, and storage, planning, validation, hashing, and GitHub operations in src/core/. The Ink/React interface is split between src/tui/screens/, reusable src/tui/components/, and shared state in src/tui/state.ts. Tests live in test/: core lifecycle coverage is in core.integration.test.ts, GitHub URL parsing in github.test.ts, and rendered/interactive terminal behavior in tui.test.tsx. Build output goes to dist/ and should not be hand-edited.

Build, Test, and Development Commands

  • pnpm install installs the locked dependencies (Node.js 22+ and the system git command are required).
  • pnpm typecheck runs strict TypeScript checks without emitting files.
  • pnpm test runs the Bun test suite.
  • pnpm build bundles and minifies src/cli.tsx into dist/cli.js.
  • pnpm start runs the built CLI; rebuild after source changes. Use node dist/cli.js --help for non-interactive command discovery.

Coding Style & Naming Conventions

Use TypeScript/TSX with two-space indentation, single quotes, semicolons, and ESM imports. Include .js extensions for local imports, matching NodeNext resolution. Use camelCase for functions and variables, PascalCase for React components and types, and kebab-case filenames such as select-deck.ts. Keep core filesystem and business logic separate from prompts and rendering. Preserve strict typing; avoid unchecked assertions unless a preceding check establishes the invariant.

No formatter or linter is configured, so match nearby code and run pnpm typecheck before submitting.

Testing Guidelines

Write tests with bun:test; name files *.test.ts or *.test.tsx. Add focused unit tests for parsers and schemas, integration tests for storage/project lifecycles, and ink-testing-library tests for visible TUI or keyboard changes. Use temporary directories and clean them in afterEach; keep tests cross-platform and avoid network access. Run pnpm test and pnpm typecheck for every change. No numeric coverage threshold is currently enforced.

Commit & Pull Request Guidelines

Recent commits use concise, imperative, sentence-case subjects, for example Fix concurrent library imports. Keep commits scoped to one behavior. Pull requests should explain the user-visible change, call out safety or compatibility implications, and list verification commands. Link relevant issues and include terminal screenshots or captured frames for TUI changes.

Security & Data Safety

Skdeck manages user files and untrusted GitHub content. Preserve path-traversal and symlink protections, atomic writes, locking, immutable revisions, and checks that prevent overwriting unmanaged or locally modified skills.

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.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

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.

Check your setup, free