mirrord

Discord

(Discord link)

License

MIT

GitHub release (latest SemVer)

(link to GitHub release)

Twitter Follow

(Twitter follow link)

mirrord lets developers run local processes in the context of their cloud environment. It’s meant to provide the benefits of running your service on a cloud environment (e.g., staging) without actually going through the hassle of deploying it there, and without disrupting the environment by deploying untested code. It comes as a Visual Studio Code extension, an IntelliJ plugin, and a CLI tool.

Contents

• Getting Started
• VS Code Extension
• IntelliJ Plugin
• CLI Tool
• How It Works
• FAQ
• Contributing
• Help and Community
• Code of Conduct
• License

Getting Started

VS Code Extension

Installation

(instructions to install VS Code extension)

How To Use

(instructions on how to use the VS Code extension)

IntelliJ Plugin

Installation

(instructions to install IntelliJ plugin)

How To Use

(instructions on how to use the IntelliJ plugin)

CLI Tool

Installation

(instructions to install CLI tool)

How To Use

(instructions on how to use the CLI tool)

How It Works

(description of how mirrord works)

Additional capabilities:

• CAP_NET_ADMIN and CAP_NET_RAW - for modifying routing tables
• CAP_SYS_PTRACE - for reading target pod environment
• CAP_SYS_ADMIN - for joining target pod network namespace

You can disable any subset of those in the configuration.

MIRRORD_AGENT_DISABLED_CAPABILITIES=CAP_NET_RAW,CAP_SYS_PTRACE mirrord exec node app.js --target pod/my-pod

FAQ

(link to FAQ)

If you have a question that's not on there, feel free to ask in our Discussions or on Discord.

Contributing

(description of how to contribute)

We're available on Discord for any questions.

Help and Community

Join our Discord Server for questions, support, and fun.

Code of Conduct

(link to Code of Conduct)

License

MIT