Skip to main content

Internal Info Replacement CLI

Project description

iir — Internal Info Replacement

iir (Internal Info Replacement) is a lightweight system for safely replacing internal identifiers (hosts, domains, service names, user names, etc.) before sharing logs, documents, or prompts with external parties or AI systems.

It is designed as a structural safety layer: a tool that helps humans safely sanitize (replace) internal identifiers before sharing information outside a trusted boundary.


Intended usage note

iir is designed to be used inside a local or private environment such as a developer machine, LAN, or internal network, as a preprocessing tool before sharing text with external services (including public or hosted LLMs).

iir itself is not intended to be exposed as a public service. How and where it is operated is the responsibility of the user.

Please note that the dictionary used by iir should be treated as your private internal data.

iir is a utility to assist safe replacement workflows. It does not claim to provide complete security guarantees.


About MCP integration

MCP support is planned as an optional execution mode for iir. It is primarily intended for on-premise or self-hosted LLM setups.

MCP integration does not change the core concept of iir. Replacement logic and safety assumptions remain the same, and MCP is not required for using iir effectively.


Installation

pip install iir-tool

Note: The PyPI package name is iir-tool, but the CLI command is iir.


Two usage modes

1. Local / personal mode (CLI-first)

Designed for individual users and local workflows.

Typical use cases:

  • Preparing logs or text before sharing
  • Sanitizing prompts before sending to AI tools
  • Ad-hoc replacement in pipelines or scripts

Characteristics:

  • CLI-first design (stdin → stdout)
  • Simple installation
  • No external services required

2. Shared / boundary mode (API / Web / MCP)

Intended to be deployed inside a LAN or private environment and act as a boundary before data is shared externally.

Examples:

  • HTTP-based replacement service (internal use)
  • Web-based replacement form for inspection
  • MCP adapter as an optional LLM safety layer

This mode is not designed for public exposure.


Basic usage (CLI)

Before using iir for the first time, initialize the local working directory:

iir dev-init

Then register entries and run replacement:

echo "my.domain" | iir add-entry DOMAIN
echo "connect to my.domain" | iir replace

Maintenance and administration

iir intentionally keeps its CLI minimal. Maintenance tasks such as inspection, correction, or cleanup are performed via Django Admin.

For details, see:

Note: For advanced or non-interactive local workflows, iir can store its local state in a directory specified by the DATA_DIR environment variable. See the maintenance documentation for details.


Documentation


License

This project is licensed under the MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

iir_tool-0.1.14.tar.gz (18.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

iir_tool-0.1.14-py3-none-any.whl (22.9 kB view details)

Uploaded Python 3

File details

Details for the file iir_tool-0.1.14.tar.gz.

File metadata

  • Download URL: iir_tool-0.1.14.tar.gz
  • Upload date:
  • Size: 18.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for iir_tool-0.1.14.tar.gz
Algorithm Hash digest
SHA256 a5023a11824e7751dad23e551e6827a3757a30c9b3b1ed18407c9b8df2715898
MD5 65d589c4b2c8e00c17d29977ac71df1e
BLAKE2b-256 79b6f5bb38e61fd07b915fa9bd922da6cf519e75541e79eb844b1a46765ff068

See more details on using hashes here.

File details

Details for the file iir_tool-0.1.14-py3-none-any.whl.

File metadata

  • Download URL: iir_tool-0.1.14-py3-none-any.whl
  • Upload date:
  • Size: 22.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for iir_tool-0.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 37d0a9e2b670486f614983854358282d6ea5576c7472998bf4a8c38538439907
MD5 df530876898943666a26e0899427fb75
BLAKE2b-256 0d1e4496921ddda620be360c19bfbdeb8090642f3178919b2887b3d77386be43

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page