Redact

• Overview
• CLI
  • Requirements
  • Installation
    • .deb Package Installation
    • .rpm Package Installation
    • Installation From Hackage
    • Installation From Stackage
  • Usage
• Project
  • Links
  • Tags
  • Contribution
  • License

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.