Go to file
Justus Winter 6cd2ae9d3b
Point users to our user manual.
- Previously, we pointed users to the API documentation, which
    doesn't seem helpful at all.
2024-01-12 18:22:43 +01:00
.ci ci: Fix all-commits job. 2023-03-13 15:49:57 +01:00
src Point users to our user manual. 2024-01-12 18:22:43 +01:00
subplot Reincarnation commit. 2023-02-21 12:43:43 +01:00
tests tests: Detach console for child processes. 2024-01-08 14:18:42 +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 Improve rendering of examples. 2024-01-11 13:41: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 std::io::IsTerminal instead of is-terminal. 2024-01-08 14:18:42 +01:00
Cargo.toml Use std::io::IsTerminal instead of is-terminal. 2024-01-08 14:18:42 +01:00
deny.toml ci: Allow fehler 2023-10-17 14:52:16 +02:00
Dockerfile Build and push Docker image to Gitlab's registry. 2023-03-13 12:54:00 +01:00
LICENSE.txt Fix license 2023-11-24 16:37:14 +01:00
NEWS Update NEWS. 2023-12-15 18:29:08 +01:00
README.md Add documentation links to the README.md. 2024-01-10 17:52:47 +01:00
sq-subplot.md Create a new top-level network, and move relevant subcommands there. 2024-01-12 12:41:47 +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.

Building

This crate can be built 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.