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. Depending on how entries are curated, it can easily become sensitive or security-relevant information.

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, where model outputs need to be sanitized before being exposed externally.

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 (Important)

iir supports two complementary usage modes.

1. Local / Personal Mode (CLI-First)

Designed for individual users and local workflows.

Typical uses 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 (extra config not required)
  • Suitable for quick evaluation via quickstart

2. Shared / Boundary Mode (API / Web / MCP)

This mode is intended to be deployed inside a LAN or private environment and to act as a boundary before data is shared with external services. It is not designed or recommended to be operated as a publicly exposed service.

This mode is commonly used in shared environments, team usage, and organizational boundaries.

Examples:

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

Basic Usage (CLI, Recommended)

Development initialization (dev-init / dev-remove)

For local development and evaluation, iir provides explicit helper commands to initialize and clean up the working directory.

iir dev-init

iir dev-init

This command performs the following actions in the current directory:

  • Creates .env.secret if it does not already exist
    (contains DJANGO_SECRET_KEY for local use)
  • Creates db.sqlite3 in the current directory (SQLite)
  • Runs Django migrations against that database

After running dev-init, the directory will contain:

.env.secret
db.sqlite3

These files are local development artifacts and should normally be excluded from version control.

iir dev-remove

iir dev-remove

This command removes .env.secret from the current directory.

Notes:

  • dev-remove does not delete db.sqlite3
  • Database removal is intentionally left to the user
  • This avoids accidental data loss

Important notes

  • dev-init and dev-remove are explicit developer helpers
  • iir will never create or migrate databases implicitly during normal commands such as replace
  • Database initialization is always a deliberate action

This design keeps database state predictable and avoids unintended side effects.

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

Links


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.11.tar.gz (17.8 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.11-py3-none-any.whl (22.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: iir_tool-0.1.11.tar.gz
  • Upload date:
  • Size: 17.8 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.11.tar.gz
Algorithm Hash digest
SHA256 2b24398085149ecce691c5c152bf725e4937c37e992232db38b32c5b24bac27e
MD5 bdd9b3d1b27a0099a4dc9a302a71f02d
BLAKE2b-256 cfe0c6abe96c282bb3cdf7698091929ce91c7c6542f63138ce79c4ef2a49edfa

See more details on using hashes here.

File details

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

File metadata

  • Download URL: iir_tool-0.1.11-py3-none-any.whl
  • Upload date:
  • Size: 22.0 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.11-py3-none-any.whl
Algorithm Hash digest
SHA256 ed75fe5226a0690e53656e0a88deb1097fd8f4d5937e6b5d71af1bdcb7613a22
MD5 3ad52351bb15f7c4bfc263319ceba87b
BLAKE2b-256 262cc5f36142c4e10da544a5898725adabb86d143fe6b6113c7c136daf375783

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