Imported from darthjee/tingle (
AGENTS.md). Install upstream withnpx skills add darthjee/tingle. Copyright stays with the author.
Project Instructions
Last updated: 2026-09-23
You are an assistant helping maintain Tingle, a personal collection of small, independent utility scripts.
Tingle is a personal repository of everyday utility scripts — a code "Swiss Army knife". It has no single theme; each script is a small, independent tool for a recurring task such as file scraping, bulk renaming, or copying files between git branches.
Stack
- Shell (Bash) —
shell/ - Python —
python/ - Node.js —
node/
Conventions
- Should: Scripts are independent and runnable on their own — avoid introducing cross-script dependencies unless truly shared.
- Should: Each script document its own usage and dependencies in a header comment.
- Should: New scripts be added to the table in
README.md.
Boundaries
- Never: introduce cross-script dependencies unless truly shared.
- Must: document a script's usage and dependencies in a header comment whenever it is added or modified.
- Must: add a new script to the table in
README.md. - Never: place implementation code outside
shell/,python/,node/, orbin/. - Never: place documentation anywhere other than
docs/guides/(user-facing guides) ordocs/agents/(agent-facing docs). - Must: update the relevant file(s) under
docs/agents/whenever an architectural change is made. - Must: update the matching guide in
docs/guides/whenever a command's behaviour changes.
Tools
Specialist agents are defined under .claude/agents/, which holds their
full descriptions. Delegate work to the agent that owns the area:
architect— cross-cutting tasks, multi-agent coordination, root-level files.cli— entry points underbin/(arg parsing,--help, exit codes, dispatch into the language folders).node— Node.js scripts undernode/.python— Python scripts underpython/.shell— Bash/Shell scripts undershell/.product-owner— content underdocs/agents/(architecture, flow, folder structure, contributing, issues, plans).guide— content underdocs/guides/(end-user guides, one pertinglecommand, and the guides index).
Documentation
Agent-facing project documentation lives under
docs/agents/; end-user guides live under
docs/guides/:
| File | Contents |
|---|---|
| Folder Structure | Top-level directory layout and the role of each folder. |
| Architecture | Source layout, modules, code style, and implementation guidelines. |
| Flow | Main runtime flow of the application. |
| Plans | Implementation plans for ongoing or upcoming features. |
| Issues | Detailed specs for open issues. |
| Contributing | Commit guidelines, PR standards, code organization, and refactoring rules. |
| User Guides | End-user guides, one per tingle command. |
Issues (docs/agents/issues/)
Each file documents an issue in detail. Naming convention:
docs/agents/issues/<issue_id>_<issue_name>.md
Example: docs/agents/issues/5_release_docker_image.md for issue #5.
Plans (docs/agents/plans/)
Each plan is a directory named after the issue ID and topic, containing one or more related files:
docs/agents/plans/<issue_id>_<topic>/<related_files>.md
Example: docs/agents/plans/12_add-auth/plan.md for issue #12.