⌨️ Use from a Command Line Interface

Check, sign, and publish Nanopubs from your terminal using the binary for your platform.

📥️ Install

Download the binary adapted to your platform from the repository Releases page:

• 🐧 Linux
• 🍎 MacOS
• 🪟 Windows

Rename the binary to np (or anything you prefer), and put it in your path.

You can do it easily on Linux, MacOS, and Windows WSL, by using our install script:

curl -sSL https://raw.github.com/vemonet/nanopub-rs/main/scripts/install-binary.sh | bash

✍️ Sign

You can define the path to the key pair used for signing in a profile.yml which contains the following information:

~/.nanopub/profile.yml

orcid_id: https://orcid.org/0000-0000-0000-0000
name: Your Name
public_key: /home/user/.nanopub/id_rsa.pub
private_key: /home/user/.nanopub/id_rsa
introduction_nanopub_uri:

Sign a Nanopub, by default it will try to use the profile available at ~/.nanopub/profile.yml

np sign nanopub.trig

Sign a Nanopub, using a specific private key file:

np sign nanopub.trig -k ~/.nanopub/id_rsa

Sign a Nanopub, using a profile.yml file:

np sign nanopub.trig -p ~/.nanopub/profile.yml

📬️ Publish

Check and publish a signed nanopub, or sign and publish an unsigned nanopub:

np publish signed.nanopub.trig

You can use the same -p and -k options that are available for the np sign command

🔎 Check

Check if a signed nanopub is valid. It will check the Trusty hash, and signature based on the public key:

np check signed.nanopub.trig

⏭️ Enable completions

You can generate and enable completions for your shell:

• 🪐 ZSH

  np completions zsh > ~/.zsh/completion/np
  source ~/.zsh/completion/np
  

• 🥊 Bash

  np completions bash > ~/.bash_completion.d/np
  source ~/.bash_completion.d/np
  

• 🐟 Fish

  np completions bash > ~/.config/fish/completions/np
  source ~/.config/fish/completions/np
  

Add the source command to your .zshrc or .bashrc if not already done.