{"id":24583692,"url":"https://github.com/toebeann/typedoc-plugin-versions-cli","last_synced_at":"2025-04-28T10:39:01.209Z","repository":{"id":59336185,"uuid":"536724904","full_name":"toebeann/typedoc-plugin-versions-cli","owner":"toebeann","description":"A companion CLI tool for typedoc-plugins-versions.","archived":false,"fork":false,"pushed_at":"2024-10-28T05:42:58.000Z","size":1816,"stargazers_count":4,"open_issues_count":6,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-20T01:03:32.446Z","etag":null,"topics":["cd","ci","ci-cd","cicd","cid","cli","command","javascript","typedoc","typedoc-plugin","typedoc-plugin-versions","typescript","utility"],"latest_commit_sha":null,"homepage":"https://toebeann.github.io/typedoc-plugin-versions-cli","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/toebeann.png","metadata":{"funding":{"github":["toebeann"],"ko_fi":"toebean_","custom":["https://paypal.me/tobeyblaber"]},"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-09-14T19:10:44.000Z","updated_at":"2024-06-22T11:06:38.000Z","dependencies_parsed_at":"2023-12-25T09:34:25.538Z","dependency_job_id":"7e7bd2b0-212d-464c-8fb6-64dd8eef7f0e","html_url":"https://github.com/toebeann/typedoc-plugin-versions-cli","commit_stats":{"total_commits":189,"total_committers":2,"mean_commits":94.5,"dds":"0.48677248677248675","last_synced_commit":"58e5b0ef648f5b55ad119f893bfe4d9ecf77ddfa"},"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toebeann%2Ftypedoc-plugin-versions-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toebeann%2Ftypedoc-plugin-versions-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toebeann%2Ftypedoc-plugin-versions-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toebeann%2Ftypedoc-plugin-versions-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/toebeann","download_url":"https://codeload.github.com/toebeann/typedoc-plugin-versions-cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251296629,"owners_count":21566646,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cd","ci","ci-cd","cicd","cid","cli","command","javascript","typedoc","typedoc-plugin","typedoc-plugin-versions","typescript","utility"],"created_at":"2025-01-24T04:48:19.346Z","updated_at":"2025-04-28T10:39:01.187Z","avatar_url":"https://github.com/toebeann.png","language":"TypeScript","funding_links":["https://github.com/sponsors/toebeann","https://ko-fi.com/toebean_","https://paypal.me/tobeyblaber"],"categories":[],"sub_categories":[],"readme":"\u003ccenter\u003e\n\n# typedoc-plugin-versions-cli 🧑‍💻\n\nA companion CLI tool for [typedoc-plugin-versions](https://citkane.github.io/typedoc-plugin-versions).\n\n[![npm package version](https://img.shields.io/npm/v/typedoc-plugin-versions-cli.svg?logo=npm\u0026label\u0026labelColor=222\u0026style=flat-square)](https://npmjs.org/package/typedoc-plugin-versions-cli \"View typedoc-plugin-versions-cli on npm\") [![npm package downloads](https://img.shields.io/npm/dw/typedoc-plugin-versions-cli.svg?logo=npm\u0026labelColor=222\u0026style=flat-square)](https://npmjs.org/package/typedoc-plugin-versions-cli \"View typedoc-plugin-versions-cli on npm\") [![typedocs](https://img.shields.io/badge/docs-informational.svg?logo=typescript\u0026labelColor=222\u0026style=flat-square)](https://toebeann.github.io/typedoc-plugin-versions-cli \"Read the documentation on Github Pages\") [![coverage](https://img.shields.io/codecov/c/github/toebeann/typedoc-plugin-versions-cli.svg?logo=codecov\u0026labelColor=222\u0026style=flat-square)](https://codecov.io/gh/toebeann/typedoc-plugin-versions-cli \"View code coverage on Codecov\") [![code quality](https://img.shields.io/codefactor/grade/github/toebeann/typedoc-plugin-versions-cli.svg?logo=codefactor\u0026labelColor=222\u0026style=flat-square)](https://www.codefactor.io/repository/github/toebeann/typedoc-plugin-versions-cli \"View code quality on CodeFactor\") [![license](https://img.shields.io/github/license/toebeann/typedoc-plugin-versions-cli.svg?logo=open-source-initiative\u0026logoColor=3DA639\u0026color=informational\u0026labelColor=222\u0026style=flat-square)](https://github.com/toebeann/typedoc-plugin-versions-cli/blob/main/LICENSE \"View the license on GitHub\")\n\n[![npm test](https://img.shields.io/github/actions/workflow/status/toebeann/typedoc-plugin-versions-cli/npm-test.yml?branch=main\u0026logo=github\u0026logoColor=aaa\u0026label=npm%20test\u0026labelColor=222\u0026style=flat-square)](https://github.com/toebeann/typedoc-plugin-versions-cli/actions/workflows/npm-test.yml \"View npm test on GitHub Actions\") [![publish code coverage](https://img.shields.io/github/actions/workflow/status/toebeann/typedoc-plugin-versions-cli/publish-code-coverage.yml?branch=main\u0026logo=github\u0026logoColor=aaa\u0026label=publish%20code%20coverage\u0026labelColor=222\u0026style=flat-square)](https://github.com/toebeann/typedoc-plugin-versions-cli/actions/workflows/publish-code-coverage.yml \"View publish code coverage on GitHub Actions\") [![publish package](https://img.shields.io/github/actions/workflow/status/toebeann/typedoc-plugin-versions-cli/publish-package.yml?branch=main\u0026logo=github\u0026logoColor=aaa\u0026label=publish%20package\u0026labelColor=222\u0026style=flat-square)](https://github.com/toebeann/typedoc-plugin-versions-cli/actions/workflows/publish-package.yml \"View publish package on GitHub Actions\") [![publish docs](https://img.shields.io/github/actions/workflow/status/toebeann/typedoc-plugin-versions-cli/publish-docs.yml?branch=main\u0026logo=github\u0026logoColor=aaa\u0026label=publish%20docs\u0026labelColor=222\u0026style=flat-square)](https://github.com/toebeann/typedoc-plugin-versions-cli/actions/workflows/publish-docs.yml \"View publish docs on GitHub Actions\")\n\n[![github](https://img.shields.io/badge/source-informational.svg?logo=github\u0026labelColor=222\u0026style=flat-square)](https://github.com/toebeann/typedoc-plugin-versions-cli \"View typedoc-plugin-versions-cli on GitHub\") [![twitter](https://img.shields.io/badge/follow-blue.svg?logo=twitter\u0026label\u0026labelColor=222\u0026style=flat-square)](https://twitter.com/toebean__ \"Follow @toebean__ on Twitter\") [![GitHub Sponsors donation button](https://img.shields.io/badge/sponsor-e5b.svg?logo=github%20sponsors\u0026labelColor=222\u0026style=flat-square)](https://github.com/sponsors/toebeann \"Sponsor typedoc-plugin-versions-cli on GitHub\") [![PayPal donation button](https://img.shields.io/badge/donate-e5b.svg?logo=paypal\u0026labelColor=222\u0026style=flat-square)](https://paypal.me/tobeyblaber \"Donate to typedoc-plugin-versions-cli with PayPal\")\n\n\u003c/center\u003e\n\n## Table of contents\n\n- [typedoc-plugin-versions-cli 🧑‍💻](#typedoc-plugin-versions-cli-)\n  - [Table of contents](#table-of-contents)\n  - [Install](#install)\n    - [npm](#npm)\n  - [Usage](#usage)\n    - [Commands](#commands)\n      - [purge](#purge)\n        - [Options](#options)\n      - [synchronize](#synchronize)\n        - [Options](#options-1)\n  - [License](#license)\n\n## Install\n\n### [npm](https://www.npmjs.com/package/typedoc-plugin-versions-cli \"npm is a package manager for JavaScript\")\n\n```text\nnpm i --global typedoc-plugin-versions-cli\n```\n\n```text\nnpm i -D typedoc-plugin-versions-cli\n```\n\n## Usage\n\nRun any of the following from the command line:\n\n```text\ntpv \u003ccommand\u003e [options..]\n```\n\n```text\ntypedoc-plugin-versions-cli \u003ccommand\u003e [options..]\n```\n\n```text\ntypedoc-plugin-versions \u003ccommand\u003e [options..]\n```\n\n```text\ntypedoc-versions \u003ccommand\u003e [options..]\n```\n\nSee details about the various [commands](#commands) and their options via the `--help` flag:\n\n```text\ntpv --help\n```\n\nAll `boolean` flags which are `true` by default can be negated by prefixing with `no-`, e.g., the following are equivalent:\n\n```text\ntpv purge --no-stale\ntpv purge --stale false\n```\n\nWhen installing as a local dev dependency, you may need to prefix the commands with `npx`, e.g.:\n\n```text\nnpx tpv \u003ccommand\u003e [options..]\n```\n\n### Commands\n\n#### purge\n\nDeletes old doc builds and/or versions matching semver ranges. To synchronize metadata and symbolic links after, run [`tpv sync`](#synchronize).\n\n```text\ntpv purge [versions..] [flags]\n```\n\nDisplays a confirmation prompt before performing changes.\n\n##### Options\n\n- **`--stale [boolean] [default: true]`**\u003cbr/\u003ePurge stale doc builds, e.g. `v1.0.0-alpha.1` is considered stale once `v1.0.0` has been built.\u003cbr/\u003e\u003cbr/\u003e\n- **`--major \u003cnumber\u003e [default: Infinity]`**\u003cbr/\u003ePurge all but the specified number of major versions.\u003cbr/\u003e\u003cbr/\u003e\n- **`--minor \u003cnumber\u003e [default: Infinity]`**\u003cbr/\u003ePurge all but the specified number of minor versions per major version.\u003cbr/\u003e\u003cbr/\u003e\n- **`--patch \u003cnumber\u003e [default: Infinity]`**\u003cbr/\u003ePurge all but the specified number of patch versions per minor version.\u003cbr/\u003e\u003cbr/\u003e\n- **`--exclude \u003cversions..\u003e`**\u003cbr/\u003eExclude versions matching the specified semver ranges from the purge operation.\u003cbr/\u003e\u003cbr/\u003e\n- **`--pre`**, **`--prerelease [boolean] [default: false]`**\u003cbr/\u003eInclude prerelease versions when evaluating semver ranges.\u003cbr/\u003e\u003cbr/\u003e\n- **`-y`**, **`--yes [boolean] [default: false]`**\u003cbr/\u003eAutomatically confirms prompts.\u003cbr/\u003e\u003cbr/\u003e\n- **`--out \u003cstring\u003e`**\u003cbr/\u003eThe path to your typedoc output directory. By default this is inferred from your typedoc configuration.\u003cbr/\u003e\u003cbr/\u003e\n- **`--typedoc \u003cstring\u003e [default: \".\"]`**\u003cbr/\u003eThe path to your typedoc configuration file, e.g. `typedoc.json`. By default this is searched for in the current working directory.\u003cbr/\u003e\u003cbr/\u003e\n- **`--tsconfig \u003cstring\u003e [default: \".\"]`**\u003cbr/\u003eThe path to your TypeScript tsconfig file, e.g. `tsconfig.json`. By default this is searched for in the current working directory.\n\n#### synchronize\n\nEnsures your [typedoc-plugin-versions](https://citkane.github.io/typedoc-plugin-versions) metadata and symbolic links are up-to-date. Useful after deleting old doc builds.\n\n```text\ntpv synchronize [flags]\n```\n\n```text\ntpv sync [flags]\n```\n\nDisplays a confirmation prompt before performing changes.\n\n##### Options\n\n- **`-y`**, **`--yes [boolean] [default: false]`**\u003cbr/\u003eAutomatically confirms prompts.\u003cbr/\u003e\u003cbr/\u003e\n- **`--symlink [boolean] [default: false]`**\u003cbr/\u003eAlways ensures symbolic links are up-to-date, regardless of confirmation prompts.\u003cbr/\u003e\u003cbr/\u003e\n- **`--out \u003cstring\u003e`**\u003cbr/\u003eThe path to your typedoc output directory. By default this is inferred from your typedoc configuration.\u003cbr/\u003e\u003cbr/\u003e\n- **`--typedoc \u003cstring\u003e [default: \".\"]`**\u003cbr/\u003eThe path to your typedoc configuration file, e.g. `typedoc.json`. By default this is searched for in the current working directory.\u003cbr/\u003e\u003cbr/\u003e\n- **`--tsconfig \u003cstring\u003e [default: \".\"]`**\u003cbr/\u003eThe path to your TypeScript tsconfig file, e.g. `tsconfig.json`. By default this is searched for in the current working directory.\n\n## License\n\ntypedoc-plugin-versions-cli is licensed under [MIT](https://github.com/toebeann/typedoc-plugin-versions-cli/blob/main/LICENSE) © 2022 Tobey Blaber.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftoebeann%2Ftypedoc-plugin-versions-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftoebeann%2Ftypedoc-plugin-versions-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftoebeann%2Ftypedoc-plugin-versions-cli/lists"}