Complete User Guide

Last Updated: 2026-02-09

This guide covers every feature of the cloak.business web application in detail. For a quick overview, see the Quick Start Guide.

Table of Contents#

1. Dashboard Overview
2. Text Tab
3. File Tab
4. Batch Tab
5. Image Tab
6. Analysis Results
7. Entity Selection
8. Anonymization Methods
9. Downloading Results
10. Settings

Dashboard Overview#

After logging in, the dashboard displays:

• Token balance -- your remaining tokens and usage for the current billing cycle.
• Recent activity -- a summary of your recent analyses and anonymizations.
• Quick actions -- shortcuts to start a new text analysis, upload a file, or open settings.

Text Tab#

The Text tab is the primary interface for analyzing and anonymizing text.

Entering Text#

• Paste or type text directly into the input area.
• There is no strict character limit, but longer texts consume more tokens.

Language Selection#

• Auto-detect (default): the system identifies the language automatically.
• Manual selection: choose a specific language from the dropdown to improve detection accuracy for that language.
• Language selection affects which NLP model is loaded and which context words are used for pattern matching.

Running Analysis#

1. Enter your text.
2. Select a language (or leave on auto-detect).
3. Click Analyze.
4. Wait for results to appear. Analysis typically takes 1-3 seconds for a page of text.

File Tab#

Upload documents for text extraction and analysis.

Supported File Types#

How It Works#

1. Click Upload or drag and drop a file into the upload area.
2. Text is extracted from the file automatically.
3. The extracted text is analyzed for PII using the same engine as the Text tab.
4. Review and anonymize results as usual.

Batch Tab#

Process multiple documents at once with parallel processing.

Using Batch Processing#

1. Upload multiple files using the file picker or drag and drop.
2. All files are queued for processing.
3. Text is extracted from each file and analyzed in parallel.
4. Review results for each file individually.
5. Anonymize and download results per file or as a batch.

Tips#

• Batch processing is ideal for large document sets with consistent PII types.
• Apply a preset before batch processing to focus detection on relevant entity types.

Image Tab#

Detect and redact PII directly from images using OCR.

Supported Formats#

PNG, JPEG, BMP, and TIFF images up to 10 MB.

How It Works#

1. Upload an image containing text (scanned documents, screenshots, photos of forms).
2. OCR extracts text and character positions from the image.
3. The extracted text is analyzed for PII.
4. Detected entities are highlighted with bounding boxes on the image.
5. Click Redact to produce a new image with PII covered by filled rectangles.

For full details, see the Image Anonymization Guide.

Analysis Results#

After running an analysis, results appear in the right panel.

Entity List#

Each detected entity shows:

• Type: the category of PII (e.g., PERSON, EMAIL_ADDRESS, PHONE_NUMBER).
• Value: the detected text.
• Position: start and end character offsets in the original text.
• Confidence score: a value from 0.0 to 1.0 indicating detection confidence.

Color Coding#

Entity types are color-coded for quick visual identification:

• Each entity type is assigned a distinct color.
• The same color appears in both the highlighted text and the entity list.
• Colors are consistent across sessions.

Confidence Scores#

Entity Selection#

You have full control over which detected entities are included in anonymization.

Toggle Individual Entities#

• Click any entity in the results list to toggle it on or off.
• Disabled entities will not be anonymized.
• Use this to exclude false positives.

Select/Deselect by Type#

• Click an entity type header to toggle all entities of that type at once.
• For example, click "EMAIL_ADDRESS" to select or deselect all detected email addresses.

Presets#

• Apply a country or regional preset to automatically enable relevant entity types.
• See Presets & Entity Configuration for details.

Anonymization Methods#

Choose how each entity type is anonymized. You can set a global method or configure per entity type.

Per-Entity Configuration#

1. In the anonymization settings, expand an entity type.
2. Choose the method for that specific type.
3. Different entity types can use different methods in the same operation.

For a detailed comparison, see the Anonymizer Guide.

Downloading Results#

After anonymization, you can retrieve your results in several ways:

• Copy to clipboard -- click the copy button to copy anonymized text.
• Download as text file -- save the anonymized output as a .txt file.
• Before/after comparison -- view the original and anonymized text side by side.

Settings#

Language#

• Set the default language for analysis.
• Choose from 48 supported UI languages.

Theme#

• Switch between light and dark mode.
• The theme applies across all tabs and panels.

Entity Preferences#

• Set default entity types to detect.
• Save custom configurations as presets for reuse.

Account#

• View your token balance and usage history.
• Manage your subscription plan.
• Update your profile and password.