Gemstar

Helps you keep track of your gems and JavaScript packages.

Installation

The easiest way to install gemstar is to use Bundler:

# Shell
gem install gemstar

Alternatively, add it to the development group in your Gemfile:

gem "gemstar", group: :development

Usage

gemstar server

Gemstar diff command output

Start the interactive web UI:

gemstar server

By default, the server listens to http://127.0.0.1:2112/

To open the root page in your browser after startup:

gemstar server --open

gemstar diff

Run this after you've updated your dependencies.

# in your project directory, after bundle update:
gemstar diff

This will generate an html diff report with changelog entries for each updated package:

Gemstar diff command output

You can also specify from and to hashes or tags to generate a diff report for a specific range of commits:

gemstar diff --from 8e3aa96b7027834cdbabc0d8cbd5f9455165e930 --to HEAD

To use a time range instead of choosing the starting commit yourself:

gemstar diff --project ~/Code/my-app --since "3 weeks"

To examine a specific Gemfile.lock, pass it like this:

gemstar diff --lockfile=~/MyProject/Gemfile.lock

To diff a project from anywhere, pass the project directory or a supported project file. In project mode, gemstar includes Ruby gems plus JS packages from importmap.rb and package-lock.json when present:

gemstar diff --project ~/Code/my-app

To filter a project diff down to one ecosystem:

gemstar diff --project ~/Code/my-app --ecosystem js
gemstar diff --project ~/Code/my-app --ecosystem gems

To write markdown instead of html:

gemstar diff --format markdown

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/FDj/gemstar.

Credits

This gem is generated via newgem template by @palkan.

License

The gem is available as open source under the terms of the MIT License.