Go to file
2024-01-29 19:48:51 +01:00
.ci ci: Fix all-commits job. 2023-03-13 15:49:57 +01:00
src Turn Autocrypt Gossip into PKI artifacts when importing. 2024-01-29 19:48:51 +01:00
subplot Reincarnation commit. 2023-02-21 12:43:43 +01:00
tests Avoid deprecated functionality. 2024-01-29 19:48:51 +01:00
.gitattributes Add git configuration. 2023-02-23 11:22:01 +01:00
.gitignore Add git configuration. 2023-02-23 11:22:01 +01:00
.gitlab-ci.yml Turn Autocrypt Gossip into PKI artifacts when importing. 2024-01-29 19:48:51 +01:00
build.rs Use the README.md as top-level crate documentation. 2024-01-10 18:00:33 +01:00
Cargo.lock Use sequoia-cert-store to manage shadow CAs. 2024-01-29 19:07:14 +01:00
Cargo.toml Use sequoia-cert-store to manage shadow CAs. 2024-01-29 19:07:14 +01:00
deny.toml ci: Allow fehler 2023-10-17 14:52:16 +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 Update NEWS. 2024-01-19 14:06:24 +01:00
README.md Improve build and installation instructions. 2024-01-19 14:13:14 +01:00
sq-subplot.md Implement sq version, drop --version, move output-version there. 2024-01-19 12:55:13 +01: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.