{"_id":"@archiel/teach-me","name":"@archiel/teach-me","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@archiel/teach-me","version":"1.0.0","description":"A token-conscious Codex skill that explains technical changes like a teacher.","license":"MIT","author":{"name":"Liriel","email":"lirielcastroreis@gmail.com"},"repository":{"type":"git","url":"git+https://github.com/LirielC/teach-me.git"},"homepage":"https://github.com/LirielC/teach-me#readme","bugs":{"url":"https://github.com/LirielC/teach-me/issues"},"publishConfig":{"access":"public"},"keywords":["codex","codex-skill","openai","education","developer-tools"],"engines":{"node":">=18"},"_id":"@archiel/teach-me@1.0.0","gitHead":"a4c187800ff81f0d4ad3207185b5dc64dc19ece0","_nodeVersion":"22.20.0","_npmVersion":"10.9.3","dist":{"integrity":"sha512-3+ogdiVKjvok5QzTv4nmapaZXZ1rAZGbcZ45/qeeNC/LpjfyOJzKbcRkChAt0G6Q4d/D0Xk4DRoVkLee55C2uA==","shasum":"fd8a080eeaf6b8797be31fe9f856537f59a92020","tarball":"https://registry.npmjs.org/@archiel/teach-me/-/teach-me-1.0.0.tgz","fileCount":5,"unpackedSize":7309,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIEX1JuYkHM8pqmLbtmQmjq6qBHVRlreH/gV9WubGFYdYAiEA0W0DOpr8LkAn1P86eq5QfVQJtr+kz1b5XNGdfl4FlGY="}]},"_npmUser":{"name":"archiel","email":"lirielcastroreis@gmail.com"},"directories":{},"maintainers":[{"name":"archiel","email":"lirielcastroreis@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/teach-me_1.0.0_1783877478999_0.5679154278756655"},"_hasShrinkwrap":false}},"time":{"created":"2026-07-12T17:31:18.807Z","1.0.0":"2026-07-12T17:31:19.151Z","modified":"2026-07-12T17:31:19.401Z"},"maintainers":[{"name":"archiel","email":"lirielcastroreis@gmail.com"}],"description":"A token-conscious Codex skill that explains technical changes like a teacher.","homepage":"https://github.com/LirielC/teach-me#readme","keywords":["codex","codex-skill","openai","education","developer-tools"],"repository":{"type":"git","url":"git+https://github.com/LirielC/teach-me.git"},"author":{"name":"Liriel","email":"lirielcastroreis@gmail.com"},"bugs":{"url":"https://github.com/LirielC/teach-me/issues"},"license":"MIT","readme":"# teach-me\r\n\r\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)\r\n\r\nA lightweight Codex skill that turns completed technical changes into short, teacher-style explanations—without turning every response into a long tutorial.\r\n\r\n`teach-me` explains:\r\n\r\n- what changed;\r\n- how the solution works;\r\n- why that approach was chosen;\r\n- one reusable lesson, when it adds value.\r\n\r\nThe default debrief is limited to 80 words and adapts to the user's technical level.\r\n\r\n## Example\r\n\r\nAfter implementing a validation fix, Codex may finish with:\r\n\r\n> **Learning:** Validation now runs before submission, so invalid data never reaches the API. The rule lives in one function to avoid duplicated behavior. Centralizing validation makes future changes safer because every caller follows the same rule.\r\n\r\n## Installation\n\n### npm\n\n```bash\nnpm install @archiel/teach-me\n```\n\nCopy the installed package from `node_modules/@archiel/teach-me` into your Codex `skills/teach-me` directory. For a direct installation into the Codex skills directory, use Git as shown below.\n\n### macOS and Linux\n\r\n```bash\r\ngit clone https://github.com/LirielC/teach-me.git ~/.codex/skills/teach-me\r\n```\r\n\r\n### Windows PowerShell\r\n\r\n```powershell\r\ngit clone https://github.com/LirielC/teach-me.git \"$HOME\\.codex\\skills\\teach-me\"\r\n```\r\n\r\nIf `CODEX_HOME` points somewhere else, install the repository inside its `skills` directory instead. Restart Codex after installation if the skill is not discovered immediately.\r\n\r\n## Usage\r\n\r\nInvoke the skill explicitly for predictable activation:\r\n\r\n```text\r\nUse $teach-me while fixing this bug.\r\n```\r\n\r\n```text\r\nRefactor this module and use $teach-me to explain the decisions.\r\n```\r\n\r\nIt can also activate implicitly when you ask Codex to explain a completed technical change, for example:\r\n\r\n```text\r\nFix this and explain what changed, how it works, and why you chose this approach.\r\n```\r\n\r\nThe skill recognizes common learning-oriented requests in English and Portuguese.\r\n\r\n## Always-on personal preference\r\n\r\nTo request the debrief after every technical change, add this short instruction to your global Codex guidance:\r\n\r\n```md\r\nAfter completing and verifying technical changes, use `$teach-me` in the final response. Keep its educational debrief concise and omit it when no technical change was made.\r\n```\r\n\r\nExplicit `$teach-me` invocation remains the most predictable option.\r\n\r\n## Token-conscious by design\r\n\r\nThe skill keeps explanations compact by instructing Codex to:\r\n\r\n- use at most 80 words by default;\r\n- condense trivial changes into one sentence;\r\n- avoid repeating summaries, diffs, commands, tests, and file lists;\r\n- focus on decisions, cause and effect, and meaningful trade-offs;\r\n- skip line-by-line narration;\r\n- expand only when asked.\r\n\r\n## How it adapts\r\n\r\n| User level | Explanation focus |\r\n| --- | --- |\r\n| Beginner | One essential concept in plain language |\r\n| Intermediate | Decisions and reusable patterns |\r\n| Advanced | Non-obvious trade-offs, invariants, and consequences |\r\n\r\n## Repository structure\r\n\r\n```text\r\nteach-me/\r\n├── agents/\r\n│   └── openai.yaml   # Codex UI metadata\r\n├── LICENSE           # MIT license\r\n├── README.md\r\n└── SKILL.md          # Trigger description and behavior\r\n```\r\n\r\n## Contributing\r\n\r\nIssues and pull requests are welcome. Keep changes concise: this skill is intentionally small so loading it consumes as little context as possible.\r\n\r\nWhen proposing a change, describe:\r\n\r\n- which prompts should trigger the skill;\r\n- how the output improves;\r\n- whether the change increases token usage.\r\n\r\n## License\r\n\r\nReleased under the [MIT License](LICENSE).\r\n","readmeFilename":"README.md","_rev":"1-650b605a65304ac7ad9d6fc06db1c847"}