Go to file
Justus Winter 180bc310e7
Silently import Alice's key in the examples.
- We want the examples to be relevant and to the point, and reflect
    the work flows that we want our users to have.  Notably, we want
    them to have their secret key material in the key store, not
    laying around on their file system.
2024-08-16 18:32:01 +02:00
.ci ci: Fix all-commits job. 2023-03-13 15:49:57 +01:00
src Silently import Alice's key in the examples. 2024-08-16 18:32:01 +02:00
subplot Reincarnation commit. 2023-02-21 12:43:43 +01:00
tests Update description of the assets used in the examples. 2024-08-16 17:49:55 +02:00
.gitattributes Add git configuration. 2023-02-23 11:22:01 +01:00
.gitignore Add a framework to format and test examples. 2024-02-09 18:08:09 +01:00
.gitlab-ci.yml ci: Enable subplot tests. 2024-08-15 14:49:01 +02:00
build.rs Only show global options in the top-level help output. 2024-02-21 12:28:32 +01:00
Cargo.lock Remove the dot output. 2024-08-14 14:29:04 +02:00
Cargo.toml Compile the RustCrypto crates with optimizations. 2024-08-15 15:48:32 +02:00
deny.toml Update deny.toml. 2024-06-14 20:52:17 +02:00
Dockerfile Fix Dockerfile. 2024-01-22 12:33:12 +01:00
LICENSE.txt Fix license 2023-11-24 16:37:14 +01:00
NEWS Add missing NEWS item for sq key approvals list. 2024-08-16 17:35:07 +02:00
openpgp-policy.toml add openpgp-policy 2024-03-06 12:35:27 -05:00
README.md Improve build and installation instructions. 2024-01-19 14:13:14 +01:00
sq-subplot.md Use sh instead of bash. 2024-08-15 15:11:55 +02:00
sq.subplot Update to the latest version of subplot 2023-03-17 10:07:17 +01:00

sq, the Sequoia-PGP command line tool

Sequoia-PGP is an implementation of OpenPGP in Rust. It includes a suite of library crates, which are meant to be used from applications. This crate provides the sq command line application. sq is aimed at command line users as a way to use OpenPGP conveniently from the command line.

See the sq user guide for instructions. The program also has built-in help, using the --help option and help subcommand:

$ sq help
...

You can also browse the manual pages, look at our acceptance criteria, and browse the rustdoc output if you want to learn about the implementation.

Installing

The sq tool can be installed using cargo:

cargo install sequoia-sq

Please see sequoia-openpgp's README for how to install build dependencies on your system.

Building from source

This crate can be built from a source checkout using the standard cargo toolchain:

cargo build

The above creates the sq executable, the manual pages, and its shell completions. By default, the manual pages and shell completions are put into the cargo target directory, but the exact location is unpredictable. To write the assets to a predictable location, set the environment variable ASSET_OUT_DIR to a suitable location.