Go to file
Justus Winter 0a8ba2b3f7
Make sq encrypt --set-metadata-filename take a simple string.
- Previously, the file name was constructed from the path of the
    input file, using some transformations that may be considered
    surprising (notably, the file name of unspecified encoding was
    transformed into UTF-8 using a lossy mechanism).

  - Avoid this opaque transformation by taking an explicit string
    argument.

  - Fixes #351.
2024-11-14 16:55:42 +01:00
src Make sq encrypt --set-metadata-filename take a simple string. 2024-11-14 16:55:42 +01:00
subplot Set a SEQUOIA_HOME directory for the subplot tests. 2024-10-21 13:00:08 +02:00
tests Make sq pki path's user ID argument a named argument. 2024-11-14 16:48:49 +01: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 Add new command sq download. 2024-11-09 13:28:17 +01:00
Cargo.toml Add new command sq download. 2024-11-09 13:28:17 +01: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 Make sq encrypt --set-metadata-filename take a simple string. 2024-11-14 16:55:42 +01:00
openpgp-policy.toml add openpgp-policy 2024-03-06 12:35:27 -05:00
README.md Link to the new user documentation. 2024-09-03 17:16:31 +02:00
sq-subplot.md Change --email and --add-email to only match user IDs unambiguously. 2024-11-13 14:29:32 +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 documentation 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.