https://github.com/frozolotl/typst-mutilate

A tool to replace words in a typst document with random garbage.
https://github.com/frozolotl/typst-mutilate

cli tools typst

Last synced: 3 months ago
JSON representation

A tool to replace words in a typst document with random garbage.

• Host: GitHub
• URL: https://github.com/frozolotl/typst-mutilate
• Owner: frozolotl
• License: eupl-1.2
• Created: 2023-07-21T19:33:27.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-09-20T14:43:57.000Z (4 months ago)
• Last Synced: 2024-10-10T23:32:55.925Z (3 months ago)
• Topics: cli, tools, typst
• Language: Rust
• Homepage:
• Size: 194 KB
• Stars: 11
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Typst-mutilate

Typst-mutilate is a tool to replace words in a typst document with random garbage.

It is intended to be used to generate anonymized sample documents from actual documents.

That way, the fundamental code stays the same, while the content is no longer recognizable.

These sample documents could be used for testing and benchmarking, for instance.

![A mutilated document](.github/example.png)

## Installation

```sh

cargo install --path .

```

## Usage

By default, typst-mutilate replaces words with random characters.

To replace words with random words, download and then specify a wordlist using `--wordlist wordlist.txt`. 

```

Usage: typst-mutilate [-i ] [-w ] [-l ] [-a]

A tool to replace all words in a typst document with random garbage.

Options:

  -i, --in-place    a file to perform in-place replacement on

  -w, --wordlist    the path to a line-separated wordlist

  -l, --language    an ISO 639-1 language code, like `de`

  -a, --aggressive  whether to replace elements that are more likely to change

                    behavior, like strings

  --help            display usage information

```

## Legal

This software is not affiliated with typst, the brand.