Skip to content

Quickstart Guide

Welcome to Privato! This quickstart guide will help you get up and running with the Privato application, which is designed to analyze and redact private data from images and documents.

Prerequisites

Before you begin, ensure you have the following prerequisites installed:

  • Python 3.11 or higher

  • pip (Python package installer)

  • uv (Python package manager)

Installation

To install Privato, you can use pip. Open your terminal and run the following command:

pip install privato

Running the Application

Once installed, you can start the Privato application using the command line interface (CLI). Open your terminal and run:

privato api run --port 8080
This command will start the Privato API server on port 8080. You can access the web interface by opening your web browser and navigating to http://127.0.0.1:8080.

To see the available commands and options, you can run: 

privato --help

This command will display the available commands and options for using Privato.

Analyzing an Image

To analyze an image for Personally Identifiable Information (PII), use the following command:

privato analyzer analyze --file path/to/your/image.jpg --language en

Redacting an Image

To redact Personally Identifiable Information (PII) from an image, use the following command:

privato redactor redact --file path/to/your/image.jpg --language en --output path/to/save/redacted_image.jpg