redact
hide secret text on the terminal
https://github.com/ExtremaIS/redact-haskell#readme
LTS Haskell 22.43: | 0.5.0.0@rev:3 |
Stackage Nightly 2024-12-07: | 0.5.0.0@rev:3 |
Latest on Hackage: | 0.5.0.0@rev:3 |
redact-0.5.0.0@sha256:54c8e939ce3fc01b1ace85e3fa42f6dcee137629dd9723914cdc1dc136472e17,2811
Module documentation for 0.5.0.0
Redact
Overview
Redact is a utility for hiding secret text on the terminal.
It is designed to work with Markdown syntax. Inline code (text enclosed in backticks) and code blocks that are fenced with backticks are hidden. Note that inline code that spans multiple lines is not supported, and other types of code blocks are not hidden.
Text is hidden by displaying it using the same color for the foreground and background. When selecting hidden text, it remains hidden in some terminals and becomes visible in other terminals.
Be sure to test it in your terminal before relying on it.
CLI
Requirements
Redact has only been tested on Linux. Testing on Windows 10 and macOS will be added in a future release.
Installation
.deb
Package Installation
Check the Releases page for .deb
packages.
.rpm
Package Installation
Check the Releases page for .rpm
packages.
Installation From Hackage
Install PhatSort from Hackage using Cabal as follows:
$ cabal v2-install redact
Installation From Stackage
Install PhatSort from Stackage using Stack as follows:
$ stack install redact
Usage
See the redact
man page for usage information.
Project
Links
- Hackage: https://hackage.haskell.org/package/redact
- Stackage: https://www.stackage.org/package/redact
- Flora: https://flora.pm/packages/@hackage/redact
- GitHub: https://github.com/ExtremaIS/redact-haskell
- GitHub Actions CI: https://github.com/ExtremaIS/redact-haskell/actions
Branches
The main
branch is reserved for releases. It may be considered stable, and
HEAD
is always the latest release.
The develop
branch is the primary development branch. It contains changes
that have not yet been released, and it is not necessarily stable.
Hackage revisions are made for metadata changes, such as relaxation of
constraints when new versions of dependencies are released. The
redact.cabal
metadata in the main
branch may therefore not match that of
Hackage. The redact.cabal
metadata in the develop
branch may match,
unless work is being done on a new release that contains other changes.
Tags
All releases are tagged in the main
branch. Release tags are signed using
the [email protected]
GPG key.
Contribution
Issues and feature requests are tracked on GitHub: https://github.com/ExtremaIS/hr-haskell/issues
Issues may also be submitted via email to [email protected].
License
This project is released under the MIT License as specified in the
LICENSE
file.
Changes
redact-haskell
Changelog
This project follows the Haskell package versioning policy, with
versions in A.B.C.D
format. A
may be incremented arbitrarily for
non-technical reasons, but semantic versioning is otherwise
followed, where A.B
is the major version, C
is the minor version, and D
is the patch version. Initial development uses versions 0.0.0.D
, for which
every version is considered breaking.
The format of this changelog is based on Keep a Changelog, with the following conventions:
- Level-two heading
Unreleased
is used to track changes that have not been released. - Other level-two headings specify the release in
A.B.C.D (YYYY-MM-DD)
format, with newer versions above older versions. - Level-three headings are used to categorize changes as follows:
- Breaking
- Non-Breaking
- Changes are listed in arbitrary order and present tense.
0.5.0.0 (2023-05-28)
Breaking
- Add support for
optparse-applicative
0.18
Non-Breaking
- Bump
ansi-terminal
dependency version upper bound - Bump
ansi-wl-pprint
dependency version upper bound - Adjust dependency constraints to match tested versions
- Fix typo in CLI error message
0.4.0.0 (2022-03-02)
Breaking
- Rewrite using a library
- Add
--lenient
flag, with strict behavior by default - Reset colors on exceptions, including Control+C
Non-Breaking
- Add tests
- Bump
optparse-applicative
dependency version upper bound
0.3.0.0 (2021-06-25)
Breaking
- Fix
--help
when usingoptparse-applicative
0.16
Non-Breaking
- Refactor Nix configuration
0.2.0.1 (2021-05-27)
Non-Breaking
- Fix link in README
0.2.0.0 (2021-05-27)
Breaking
- Add support for
optparse-applicative
0.16
Non-Breaking
- Add
.deb
and.rpm
packaging - Add Cabal support to
Makefile
- Add Cabal tests to GitHub Actions
- Add stan static analysis
0.1.0.0 (2020-11-28)
Breaking
- Initial public release