{"_id":"@archway/clio","_rev":"4-d1ac91d3632580aca6dedd6161174d16","name":"@archway/clio","dist-tags":{"latest":"0.9.3"},"versions":{"0.9.1":{"name":"@archway/clio","version":"0.9.1","keywords":["glossary","vitepress","docs","wiki","documentation"],"author":{"name":"0xbenc"},"license":"MIT","_id":"@archway/clio@0.9.1","maintainers":[{"name":"0xbenc","email":"0xbenc@gmail.com"}],"bin":{"clio":"bin/clio"},"dist":{"shasum":"ffc9e3ebe8bc38333c68c8d25d9ad53ebd213f48","tarball":"https://registry.npmjs.org/@archway/clio/-/clio-0.9.1.tgz","fileCount":10,"integrity":"sha512-MrZd+vxx+igTq6gmu5GI9TR16U0Yd3hkNx+BHzneO3H+aKmojxbFGcTmsX2Nhu4YBf+ovzZCbSm3curlINcf5g==","signatures":[{"sig":"MEYCIQCAdOpTpkCU+CEM8mvbDc6DUz8Ksr/ptQezPD3/nQTOTgIhAKTJ6aHfRChCWNa89QFbm5rKbYqkB874Vcbu34494DS1","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":36487},"type":"module","engines":{"node":">=18"},"gitHead":"6d2a3af8a0559f090ee34835b6c18b13510f82e2","private":false,"_npmUser":{"name":"0xbenc","email":"0xbenc@gmail.com"},"_npmVersion":"10.8.2","description":"CLI helpers for rich glossary support in Markdown.","directories":{},"_nodeVersion":"20.19.1","dependencies":{"chalk":"^5.4.0","fuse.js":"^7.1.0","slugify":"^1.6.6","inquirer":"^9.3.7","commander":"^12.1.0"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/clio_0.9.1_1746473871960_0.15034002462733054","host":"s3://npm-registry-packages-npm-production"}},"0.9.2":{"name":"@archway/clio","version":"0.9.2","keywords":["glossary","vitepress","docs","wiki","documentation"],"author":{"name":"0xbenc"},"license":"MIT","_id":"@archway/clio@0.9.2","maintainers":[{"name":"0xbenc","email":"0xbenc@gmail.com"}],"bin":{"clio":"bin/clio"},"dist":{"shasum":"e72e75ec4c87e354d9414e21eb0efd31d9b9cd49","tarball":"https://registry.npmjs.org/@archway/clio/-/clio-0.9.2.tgz","fileCount":10,"integrity":"sha512-6/fMVZBz1j/jNiDmVuYnexUe3NPzinlgyD8q6qQ/OBNtZfgo8XunVMs3XnZLKHXetCTmBGlkfRJF3kKHc2GwPw==","signatures":[{"sig":"MEUCIG0ADsxAEBgx1scfVag2uvF6wy8rwcgo/fVsmuMONJ7LAiEAjCFOBkdMy7OnqAWaT6JOgfKAazp7mnLMie66x4BKPds=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":37780},"type":"module","engines":{"node":">=18"},"gitHead":"deb1f9eba072cb5f83cd36712bb2ed0ad801105e","private":false,"_npmUser":{"name":"0xbenc","email":"0xbenc@gmail.com"},"_npmVersion":"10.9.0","description":"CLI helpers for rich glossary support in Markdown.","directories":{},"_nodeVersion":"22.11.0","dependencies":{"chalk":"^5.4.0","fuse.js":"^7.1.0","slugify":"^1.6.6","inquirer":"^9.3.7","commander":"^12.1.0"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/clio_0.9.2_1746550925204_0.7694267265783534","host":"s3://npm-registry-packages-npm-production"}},"0.9.3":{"name":"@archway/clio","version":"0.9.3","keywords":["glossary","vitepress","docs","wiki","documentation"],"author":{"name":"0xbenc"},"license":"MIT","_id":"@archway/clio@0.9.3","maintainers":[{"name":"0xbenc","email":"0xbenc@gmail.com"}],"bin":{"clio":"bin/clio"},"dist":{"shasum":"2a8578bf7a01daa0e32a2004f59b51cc90915d33","tarball":"https://registry.npmjs.org/@archway/clio/-/clio-0.9.3.tgz","fileCount":17,"integrity":"sha512-58YH+tdU/+xwrR+1oAC9idQ8oc0oqeUWfmPIcDf6igjwFCFU7zOH7gJM33N16efs/pX/1BZ9nzcWaCkzb7dwpw==","signatures":[{"sig":"MEUCIQDuQ9HPVKnP/TNFNK8TuxLQh+05igEhXvC+A559FLweqgIgWCL69zKaBngGAEL3QuSIZYQgoItsYe3y8wzeR4xbOw8=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":61695},"type":"module","engines":{"node":">=18"},"gitHead":"ba0a485cbfa2d91ee527e8879e4594e73ad6620e","private":false,"_npmUser":{"name":"0xbenc","email":"0xbenc@gmail.com"},"_npmVersion":"10.9.0","description":"CLI helpers for rich glossary support in Markdown.","directories":{},"_nodeVersion":"22.11.0","dependencies":{"chalk":"^5.4.0","fuse.js":"^7.1.0","slugify":"^1.6.6","inquirer":"^9.3.7","commander":"^12.1.0"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/clio_0.9.3_1746686607867_0.9556432863601554","host":"s3://npm-registry-packages-npm-production"}}},"time":{"created":"2025-05-05T19:37:51.864Z","modified":"2025-07-03T02:57:53.904Z","0.9.1":"2025-05-05T19:37:52.152Z","0.9.2":"2025-05-06T17:02:05.400Z","0.9.3":"2025-05-08T06:43:28.079Z"},"author":{"name":"0xbenc"},"license":"MIT","keywords":["glossary","vitepress","docs","wiki","documentation"],"description":"CLI helpers for rich glossary support in Markdown.","maintainers":[{"email":"0xbenc@gmail.com","name":"0xbenc"},{"email":"bhadurivikram@gmail.com","name":"basedvik"}],"readme":"# Clio\n\nCLI tools for linking and managing a glossary for documentation.\nWorks well with [Vitepress](https://vitepress.dev/) or by itself.\n\n`Clio` is not intended to be imported into code files.\n\n`Clio` modifies markdown files in a folder, via terminal.\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n![npm](https://img.shields.io/npm/v/@archway/clio)\n![semantic-release](https://img.shields.io/badge/semver‑compatible-✓-brightgreen)\n\n![Downloads](https://img.shields.io/npm/dw/@archway/clio)\n![Stars](https://img.shields.io/github/stars/off-court-creations/clio?style=social)\n\n![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen?logo=github)\n\n## Quick Start\n\n```shell\nnpm i -g @archway/clio\n```\n\n*`cd` to the parent folder of your documentation project*\n\n```shell\nclio init\n```\n\n### Automatic Glossary Suggestions\n\n```shell\nclio suggest\n```\n\n### Add a glossary entry\n\n```shell\nclio add\n```\n\n### Propogate links to glossary\n\n```shell\nclio\n```\n\n## Reference\n\n| Command | Purpose | Example |\n|---------|---------|---------|\n| **`clio init`** | Creates a clio project folder at the top directory of docs | `clio init` |\n| **`clio suggest`** | Suggests words from user's docs to add to glossary  | `clio suggest` |\n| **`clio add`** | Add a new glossary entry  | `clio add` |\n| **`clio`** | Create and update glossary links | `clio` or `clio gloss` |\n| **`clio rename`** | Rename glossary entries, recursively updating all docs pages | `clio rename` |\n| **`clio search`** | Fuzzy find a definition with a substring | `clio search Variant` |\n| **`clio stats`** | View at-a-glance stats about the project | `clio stats` |\n| **`clio toc`** | Rebuilds the Glossary Table of Contents | `clio toc` |\n| **`clio delink`** | Remove all md links to other local md files | `clio delink` |\n| **`clio help`** | View syntax and help | `clio help` |\n\n## Stabilty and Roadmap\n\nClio follows [Semantic Versioning](https://semver.org/) (semver).\n\n- **Patch (`x.y.Z`)**: Bug fixes or internal improvements with no impact on usage.\n- **Minor (`x.Y.z`)**: New features that don’t break existing behavior.\n- **Major (`X.y.z`)**: Breaking changes to commands, options, or output formats.`\n\n>The `config.json` created in the `.clio` folder when running\n>\n>```shell\n>clio init\n>```\n>\n>also contains a schema version number for potential future breaking data migrations.\n\n## Contributing\n\n`Clio` is authored by [0xbenc](https://github.com/0xbenc).\n\n<div align=\"center\"> <img src=\"https://upload.wikimedia.org/wikipedia/commons/thumb/1/1b/Charles_Meynier_-_Clio%2C_Muse_of_History_-_2003.6.5_-_Cleveland_Museum_of_Art.tiff/lossy-page1-800px-Charles_Meynier_-_Clio%2C_Muse_of_History_-_2003.6.5_-_Cleveland_Museum_of_Art.tiff.jpg\" alt=\"Clio, Muse of History by Charles Meynier\" width=\"600\"/> <br/> <sub><i>Charles Meynier – Clio, Muse of History (Cleveland Museum of Art)</i></sub> </div>\n","readmeFilename":"README.md"}