Paneron CLI

This is a CLI tool for managing a register of data entities in a Paneron repository, that follows the specification outlined here.

Installation

TBI

Usage

> # TBD

Development

Git clone this repository, then install dependencies.

git clone https://github.com/paneron/paneron-cli
cd paneron-cli
bundle install

Without Nix

Open development shell (irb) with:

bundle exec irb

Open development shell (pry) with:

bundle exec pry

Run tests with:

bundle exec rspec
# or
bundle exec rake spec

Run lint with:

bundle exec rubocop

Run lint with autocorrect with:

bundle exec rubocop -a

Release to Rubygem (adds a Git tag, pushes to GitHub and releases to Rubygem) with:

bundle exec rake release

With Nix

If your system is using Nix, run the following to gain access to shell aliases:

nix develop

Open development shell (irb) with:

irb
# or
console

Open development shell (pry) with:

pry

Run tests with:

rspec

Run lint with:

lint
# or
rubocop

Run lint with autocorrect with:

lint -a
# or
rubocop -a

Release to Rubygem (adds a Git tag, pushes to GitHub and releases to Rubygem) with:

release

Update Nix flakes with:

update-flakes

Release workflow

When actually creating a new version for release, do the following:

1. Update the VERSION in file lib/paneron/cli/version.rb.

2. git add lib/paneron/cli/version.rb
   git commit -m 'chore: Release vX.Y.Z' # change X.Y.Z to actual version
   git push
   
   # Run rake release
   bundle exec rake release

License

See LICENSE for license information.