scryptenc-cli 0.4.2

An utility for encrypt and decrypt files
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

# rscrypt

[![CI][ci-badge]][ci-url]
[![Version][version-badge]][version-url]
![License][license-badge]

**rscrypt** ([`scryptenc-cli`][version-url]) is a command-line utility for
encrypt and decrypt files.

This is a Rust implementation of `scrypt(1)`.

## Installation

### From source

```sh
cargo install scryptenc-cli
```

### From binaries

The [release page][release-page-url] contains pre-built binaries for Linux,
macOS and Windows.

### How to build

Please see [BUILD.adoc](BUILD.adoc).

## Usage

### Basic usage

Encrypt a file:

```sh
rscrypt enc file file.enc
```

Decrypt a file:

```sh
rscrypt dec file.enc file
```

### Generate shell completion

`--generate-completion` option generates shell completions to stdout.

The following shells are supported:

- `bash`
- `elvish`
- `fish`
- `powershell`
- `zsh`

Example:

```sh
rscrypt --generate-completion bash > rscrypt.bash
```

## Command-line options

Please see the following:

- [`rscrypt(1)`][rscrypt-man-url]
- [`rscrypt-enc(1)`][rscrypt-enc-man-url]
- [`rscrypt-dec(1)`][rscrypt-dec-man-url]
- [`rscrypt-info(1)`][rscrypt-info-man-url]

## Changelog

Please see [CHANGELOG.adoc](CHANGELOG.adoc).

## Contributing

Please see [CONTRIBUTING.adoc](CONTRIBUTING.adoc).

## License

Copyright © 2022–2023 Shun Sakai (see [AUTHORS.adoc](AUTHORS.adoc))

This program is distributed under the terms of the _GNU General Public License
v3.0 or later_.

See [COPYING](COPYING) for more details.

[ci-badge]: https://github.com/sorairolake/rscrypt/workflows/CI/badge.svg
[ci-url]: https://github.com/sorairolake/rscrypt/actions?query=workflow%3ACI
[version-badge]: https://img.shields.io/crates/v/scryptenc-cli
[version-url]: https://crates.io/crates/scryptenc-cli
[license-badge]: https://img.shields.io/crates/l/scryptenc-cli
[release-page-url]: https://github.com/sorairolake/rscrypt/releases
[rscrypt-man-url]: https://sorairolake.github.io/rscrypt/man/rscrypt.1.html
[rscrypt-enc-man-url]: https://sorairolake.github.io/rscrypt/man/rscrypt-enc.1.html
[rscrypt-dec-man-url]: https://sorairolake.github.io/rscrypt/man/rscrypt-dec.1.html
[rscrypt-info-man-url]: https://sorairolake.github.io/rscrypt/man/rscrypt-info.1.html