Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pabueco/ncl
Interactively view changelogs of packages and GitHub repositories in the terminal.
https://github.com/pabueco/ncl
bun changelog cli releases terminal typescript
Last synced: 13 days ago
JSON representation
Interactively view changelogs of packages and GitHub repositories in the terminal.
- Host: GitHub
- URL: https://github.com/pabueco/ncl
- Owner: pabueco
- License: mit
- Created: 2024-06-12T20:08:46.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-07-07T17:12:58.000Z (6 months ago)
- Last Synced: 2024-12-10T05:33:05.499Z (17 days ago)
- Topics: bun, changelog, cli, releases, terminal, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@pabueco/ncl
- Size: 95.7 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ncl
> nice changelog
ncl provides a quick and easy way to view the relevant changelog entries or GitHub releases for dependencies or general GitHub repositories. The main goal was to make dependeny upgrades a bit easier, but you can also use it to explore and discover changes of any GitHub repository.
Since it's aimed at locally installed packages, it makes use of the available package managers on your system to retrieve infos like repository URL and the installed version number of dependencies.
Currently the following package managers are supported:
`npm`, `pnpm`, `yarn`, `bun`, `composer`, `cargo`
You can work around unsupported package managers by providing the repository name or URL and version (optional) yourself. Support for more package managers will be added in the future.
## Installation
You can easily run `ncl` via `npx` (or alternatives like `bunx`, `pnpx` and `yarn dlx`):
```sh
# Run it directly
npx @pabueco/ncl
# or install it globally:
npm i -g @pabueco/ncl
ncl
```
> [!NOTE]
> If you want to view GitHub releases for repositories, you need to have the [GitHub CLI](https://cli.github.com/) installed.
## Usage
`` can be any dependency name (like `vue`) when you are running `ncl` inside a project directory using one of the supported package managers. When running it in any other directory `` needs to be the full name (or URL) of a GitHub repository (like `vuejs/core`, `https://github.com/vuejs/core`) or the URL of a changelog markdown file (like `https://github.com/vuejs/core/blob/main/CHANGELOG.md`).
```sh
# Basic fingerprint:
ncl []
# Viewing the changelog entries between the locally installed and the latest available version:
ncl
# Locally installed version up until version 4.x:
ncl ..4.x
# Version 2 - 4
ncl 2..4
# Only version 3.5.x
ncl 3.5
# All versions from 4
ncl 4..
# All versions
ncl all
# You can also use more complex semver ranges, but they need to be escaped in most terminals:
ncl "\>2.3 \<=2.8"
```
When specifying a version range you can use between 2 and 4 dots (e.g. `2..3` or `2....4`), so use what feels best for you.
### Advanced usage
```sh
# View changes of any repo without needing to have the dependency installed locally:
ncl vuejs/core
ncl https://github.com/vuejs/core
ncl https://raw.githubusercontent.com/vuejs/core/main/changelogs/CHANGELOG-3.2.md
ncl vuejs/core 3.x
# Change the order of changes:
ncl --order desc
# Print all changelog entries once instead of viewing them interactively:
ncl --list
```
### Options
There are a few options available to configure the behaviour if you want to.
Run `ncl --help` to see all available options.