redact: hide secret text on the terminal
This package provides a utility for redacting secret text on the terminal. Please see the README on GitHub at https://github.com/ExtremaIS/redact-haskell#readme.
[Skip to Readme]
Modules
[Index] [Quick Jump]
Flags
Automatic Flags
| Name | Description | Default |
|---|---|---|
| optparse-applicative_ge_0_18 | Use optparse-applicative 0.18 or newer | Disabled |
Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info
Downloads
- redact-0.5.0.0.tar.gz [browse] (Cabal source package)
- Package description (revised from the package)
Note: This package has metadata revisions in the cabal description newer than included in the tarball. To unpack the package including the revisions, use 'cabal get'.
Maintainer's Corner
For package maintainers and hackage trustees
Candidates
- No Candidates
| Versions [RSS] | 0.4.0.0, 0.5.0.0 |
|---|---|
| Change log | CHANGELOG.md |
| Dependencies | ansi-terminal (>=0.8.0.4 && <1.2), ansi-wl-pprint (>=0.6.8.2 && <1.1), base (>=4.10.1 && <4.20), directory (>=1.3.0.2 && <1.4), optparse-applicative (>=0.13 && <0.19), prettyprinter (>=1.7.1 && <1.8), redact, text (>=1.2.3 && <2.2) [details] |
| Tested with | ghc ==8.2.2 || ==8.4.4 || ==8.6.5 || ==8.8.4 || ==8.10.7 || ==9.0.2 || ==9.2.8 || ==9.4.8 || ==9.6.4 || ==9.8.1 |
| License | MIT |
| Copyright | Copyright (c) 2020-2023 Travis Cardwell |
| Author | Travis Cardwell <travis.cardwell@extrema.is> |
| Maintainer | Travis Cardwell <travis.cardwell@extrema.is> |
| Revised | Revision 3 made by TravisCardwell at 2024-02-07T20:02:27Z |
| Category | Utils |
| Home page | https://github.com/ExtremaIS/redact-haskell#readme |
| Bug tracker | https://github.com/ExtremaIS/redact-haskell/issues |
| Source repo | head: git clone https://github.com/ExtremaIS/redact-haskell.git |
| Uploaded | by TravisCardwell at 2023-05-28T05:05:20Z |
| Distributions | LTSHaskell:0.5.0.0, NixOS:0.5.0.0 |
| Executables | redact |
| Downloads | 348 total (8 in the last 30 days) |
| Rating | (no votes yet) [estimated by Bayesian average] |
| Your Rating | |
| Status | Docs uploaded by user Build status unknown [no reports yet] |
Readme for redact-0.5.0.0
[back to package description]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 security@extrema.is 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 bugs@extrema.is.
License
This project is released under the MIT License as specified in the
LICENSE file.