Virgil CLI

Installation | Uninstallation | Commands | Using Example | Support

Virgil Security is a stack of security libraries and all the necessary infrastructure to enable seamless, end-to-end encryption for any application, platform or device. The Command-line interface (CLI) program is a command line tool for utilizing Virgil Services. In a few simple steps you can encrypt and decrypt, sign and verify.

For a full overview head over to our documentation portal.

Installation

The Virgil CLI is provided as a script and an archive of the files, and it is available for Mac and Linux OS.

In order to use the CLI:

1. download the CLI archive or script for you platform here;
2. install the CLI with:
   • MAC OS install guide;
   • Linux OS install guide.

Uninstallation

If you need to uninstall the CLI, use this command:

./utils/uninstall.sh [--prefix=<install-prefix>] [--keep-config]

You can find example and option explanation in our documentation.

Commands

Using the CLI you can:

• Generate a Virgil Key (Private Key)
• Extract a Public Key
• Create a User's Virgil Card
• Get a User's Virgil Card
• Search for a User's Virgil Card
• Revoke a User's Virgil Card
• Encrypt data
• Decrypt the encrypted data
• Sign data
• Verify the signature
• Some additional commands:
  • Change Key format
  • See use's Card info (content)
  • Use Secret Alias

Learn more about the CLI commands in our documentation.

Using Example

Virgil Security makes it very easy to sign anything in minutes. With our CLI you need only a few lines of the code and you will get a signed data for every one of your users and devices.

Example: Alice signs some plain.txt:

Alice generates private key (private.virgilkey) with the password (strong_pass)

virgil keygen -o private.virgilkey -p strong_pass

and then Alice signs some 'plain.txt' using her private key

virgil sign -i plain.txt -o plain.signed -k private.virgilkey -p strong_pass

This will result in the creation of a newly signed file (plain.signed). In this example, the signed file will be stored in the folder, from which the command was run.

More examples about how to sign data with the CLI you can find in our documentation.

License

See LICENSE for details.

Support

Our developer support team is here to help you. You can find us on Twitter and email.