GitHub - VirgilSecurity/virgil-cli: CLI tool to manage your Virgil account and a...
source link: https://github.com/VirgilSecurity/virgil-cli
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
README.md
Virgil CLI
Virgil Security introduces to developers a Virgil CLI – a tool that provides commands for interacting with the Virgil Security services. With minimal configuration, you can start using all of the functionality provided by the Virgil from your favorite terminal program.
- Linux shells – Use common shell programs such as Bash, Zsh, and tsch to run commands in Linux, macOS, or Unix.
- Windows command line – On Microsoft Windows, run commands in either PowerShell or the Windows Command Processor.
Content
- Installation
- Launching CLI
- Manage Virgil Account
- Manage PURE application
- Manage E2EE application
- License
- Support
Installation
The Virgil CLI is provided as a binary file, and it is available for Mac OS, FreeBSD, Linux OS and Windows OS. Download the latest CLI package here: https://github.com/VirgilSecurity/virgil-cli/releases.
Launching Virgil CLI
FreeBSD / Linux / Mac OS
Run the CLI with the following command:
./virgil
or use
sudo ./virgil
when you need to run the command as an administrator
Windows OS
Run the CLI with the following command:
virgil.exe
# or just `virgil`
To get more information, run the Virgil CLI or its command with the --help
or -h
option that displays full help list and available commands.
Manage Virgil Account
Register new account
This command is used to create a new account:
# FreeBSD / Linux / Mac OS ./virgil register <email> # Windows OS virgil register <email>
Login into account
This command is used to open session for account:
# FreeBSD / Linux / Mac OS ./virgil login # Windows OS virgil login
Logout from account
This command is used to close the current session for account:
# FreeBSD / Linux / Mac OS ./virgil logout # Windows OS virgil logout
Manage PURE application
Update keys
This command is used to update the app_secret_key
and service_public_key
of a Pure application
# FreeBSD / Linux / Mac OS ./virgil pure update-keys <service_public_key> <app_secret_key> <update_token> # Windows OS virgil pure update-keys <service_public_key> <app_secret_key> <update_token>
Generate a secret key
This command is used to generate a new app_secret_key
for a Pure application:
# FreeBSD / Linux / Mac OS ./virgil pure keygen # Windows OS virgil pure keygen
Manage E2EE application
Create new E2EE application
This command is used to create new application:
# FreeBSD / Linux / Mac OS ./virgil app create --type e2ee <application name> # Windows OS virgil app create --type e2ee <application name>
Note! You have to verify your email in order to be able to create more than one application
Delete application
This command is used to delete application:
# FreeBSD / Linux / Mac OS ./virgil app delete <application_id> # Windows OS virgil app delete <application_id>
List applications
This command is used to print list of all user applications:
# FreeBSD / Linux / Mac OS ./virgil app list # Windows OS virgil app list
Update application
This command is used to update name of application:
# FreeBSD / Linux / Mac OS ./virgil app update <application_id> # Windows OS virgil app update <application_id>
Use application
This command allows you to specify the application that will be used by default. In this way, you'll be able you to use CLI commands without specifying app_id
where it's needed.
# FreeBSD / Linux / Mac OS ./virgil use <app_name> # Windows OS virgil use <app_name>
Create new api-key
This command is used to create new api-key for current application:
# FreeBSD / Linux / Mac OS ./virgil apikey create --app_id <app_id> <api-key name> # Windows OS virgil apikey create --app_id <app_id> <api-key name>
Delete api-key
This command is used to delete api-key:
# FreeBSD / Linux / Mac OS ./virgil apikey delete <api_key_id> # Windows OS virgil apikey delete <api_key_id>
List api-keys
This command is used to print list of all users api-keys:
# FreeBSD / Linux / Mac OS ./virgil apikey list # Windows OS virgil apikey list
Update api-key
This command is used to update name of api-key:
# FreeBSD / Linux / Mac OS ./virgil apikey update <api_key_id> # Windows OS virgil apikey update <api_key_id>
License
See LICENSE for details.
Support
Our developer support team is here to help you. Find out more information on our Help Center.
You can find us on Twitter or send us email [email protected].
Also, get extra help from our support team on Slack.
Recommend
About Joyk
Aggregate valuable and interesting links.
Joyk means Joy of geeK