Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/toebeann/typedoc-plugin-versions-cli
A companion CLI tool for typedoc-plugins-versions.
https://github.com/toebeann/typedoc-plugin-versions-cli
cd ci ci-cd cicd cid cli command javascript typedoc typedoc-plugin typedoc-plugin-versions typescript utility
Last synced: about 4 hours ago
JSON representation
A companion CLI tool for typedoc-plugins-versions.
- Host: GitHub
- URL: https://github.com/toebeann/typedoc-plugin-versions-cli
- Owner: toebeann
- License: mit
- Created: 2022-09-14T19:10:44.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-28T05:42:58.000Z (3 months ago)
- Last Synced: 2025-01-13T00:32:29.633Z (11 days ago)
- Topics: cd, ci, ci-cd, cicd, cid, cli, command, javascript, typedoc, typedoc-plugin, typedoc-plugin-versions, typescript, utility
- Language: TypeScript
- Homepage: https://toebeann.github.io/typedoc-plugin-versions-cli
- Size: 1.73 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# typedoc-plugin-versions-cli 🧑💻
A companion CLI tool for [typedoc-plugin-versions](https://citkane.github.io/typedoc-plugin-versions).
[](https://npmjs.org/package/typedoc-plugin-versions-cli "View typedoc-plugin-versions-cli on npm") [](https://npmjs.org/package/typedoc-plugin-versions-cli "View typedoc-plugin-versions-cli on npm") [](https://toebeann.github.io/typedoc-plugin-versions-cli "Read the documentation on Github Pages") [](https://codecov.io/gh/toebeann/typedoc-plugin-versions-cli "View code coverage on Codecov") [](https://www.codefactor.io/repository/github/toebeann/typedoc-plugin-versions-cli "View code quality on CodeFactor") [](https://github.com/toebeann/typedoc-plugin-versions-cli/blob/main/LICENSE "View the license on GitHub")
[](https://github.com/toebeann/typedoc-plugin-versions-cli/actions/workflows/npm-test.yml "View npm test on GitHub Actions") [](https://github.com/toebeann/typedoc-plugin-versions-cli/actions/workflows/publish-code-coverage.yml "View publish code coverage on GitHub Actions") [](https://github.com/toebeann/typedoc-plugin-versions-cli/actions/workflows/publish-package.yml "View publish package on GitHub Actions") [](https://github.com/toebeann/typedoc-plugin-versions-cli/actions/workflows/publish-docs.yml "View publish docs on GitHub Actions")
[](https://github.com/toebeann/typedoc-plugin-versions-cli "View typedoc-plugin-versions-cli on GitHub") [](https://twitter.com/toebean__ "Follow @toebean__ on Twitter") [](https://github.com/sponsors/toebeann "Sponsor typedoc-plugin-versions-cli on GitHub") [](https://paypal.me/tobeyblaber "Donate to typedoc-plugin-versions-cli with PayPal")
## Table of contents
- [typedoc-plugin-versions-cli 🧑💻](#typedoc-plugin-versions-cli-)
- [Table of contents](#table-of-contents)
- [Install](#install)
- [npm](#npm)
- [Usage](#usage)
- [Commands](#commands)
- [purge](#purge)
- [Options](#options)
- [synchronize](#synchronize)
- [Options](#options-1)
- [License](#license)
## Install
### [npm](https://www.npmjs.com/package/typedoc-plugin-versions-cli "npm is a package manager for JavaScript")
```text
npm i --global typedoc-plugin-versions-cli
```
```text
npm i -D typedoc-plugin-versions-cli
```
## Usage
Run any of the following from the command line:
```text
tpv [options..]
```
```text
typedoc-plugin-versions-cli [options..]
```
```text
typedoc-plugin-versions [options..]
```
```text
typedoc-versions [options..]
```
See details about the various [commands](#commands) and their options via the `--help` flag:
```text
tpv --help
```
All `boolean` flags which are `true` by default can be negated by prefixing with `no-`, e.g., the following are equivalent:
```text
tpv purge --no-stale
tpv purge --stale false
```
When installing as a local dev dependency, you may need to prefix the commands with `npx`, e.g.:
```text
npx tpv [options..]
```
### Commands
#### purge
Deletes old doc builds and/or versions matching semver ranges. To synchronize metadata and symbolic links after, run [`tpv sync`](#synchronize).
```text
tpv purge [versions..] [flags]
```
Displays a confirmation prompt before performing changes.
##### Options
- **`--stale [boolean] [default: true]`**
Purge stale doc builds, e.g. `v1.0.0-alpha.1` is considered stale once `v1.0.0` has been built.
- **`--major [default: Infinity]`**
Purge all but the specified number of major versions.
- **`--minor [default: Infinity]`**
Purge all but the specified number of minor versions per major version.
- **`--patch [default: Infinity]`**
Purge all but the specified number of patch versions per minor version.
- **`--exclude `**
Exclude versions matching the specified semver ranges from the purge operation.
- **`--pre`**, **`--prerelease [boolean] [default: false]`**
Include prerelease versions when evaluating semver ranges.
- **`-y`**, **`--yes [boolean] [default: false]`**
Automatically confirms prompts.
- **`--out `**
The path to your typedoc output directory. By default this is inferred from your typedoc configuration.
- **`--typedoc [default: "."]`**
The path to your typedoc configuration file, e.g. `typedoc.json`. By default this is searched for in the current working directory.
- **`--tsconfig [default: "."]`**
The path to your TypeScript tsconfig file, e.g. `tsconfig.json`. By default this is searched for in the current working directory.
#### synchronize
Ensures 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.
```text
tpv synchronize [flags]
```
```text
tpv sync [flags]
```
Displays a confirmation prompt before performing changes.
##### Options
- **`-y`**, **`--yes [boolean] [default: false]`**
Automatically confirms prompts.
- **`--symlink [boolean] [default: false]`**
Always ensures symbolic links are up-to-date, regardless of confirmation prompts.
- **`--out `**
The path to your typedoc output directory. By default this is inferred from your typedoc configuration.
- **`--typedoc [default: "."]`**
The path to your typedoc configuration file, e.g. `typedoc.json`. By default this is searched for in the current working directory.
- **`--tsconfig [default: "."]`**
The path to your TypeScript tsconfig file, e.g. `tsconfig.json`. By default this is searched for in the current working directory.
## License
typedoc-plugin-versions-cli is licensed under [MIT](https://github.com/toebeann/typedoc-plugin-versions-cli/blob/main/LICENSE) © 2022 Tobey Blaber.