• Welcome to RunWhen Local!
• Who Can Benefit?
• Where Can You See It in Action?
• How Can I Get It?
• How You Can Contribute
  • Expanding the Troubleshooting Library
    • Contribute to Existing Libraries
    • Create Your Own Library
    • Share New Commands or Enhance Existing Ones
  • Improving RunWhen Local
• Connect with the RunWhen Community
• Check Out Our Documentation
• What's on the Horizon?
  • Major Goals
  • Ongoing Enhancements
• Stay Updated with Release Notes

Are you tired of searching through files and wikis for those elusive CLI commands that come in handy but always need tweaking?

RunWhen Local is like your personal troubleshooter's toolbox. It's a friendly container that offers an easy-to-use web interface, filled with helpful copy & paste CLI commands specifically designed to troubleshoot applications in your Kubernetes environment. And guess what? It's open-source! Here's how it works:

1. You launch the container.
2. It scans your clusters.
3. It identifies the perfect troubleshooting commands tailored to your resources.
4. You simply copy and paste the commands to help solve your issues!

If you're involved with Kubernetes environments, RunWhen Local could be for you. It's designed for:

• Kubernetes administrators
• Kubernetes application developers
• Support teams working with Kubernetes

Curious to see it in action? We've got a few options for you:

• Check out our live demo instance here. Please note that it's linked to our sandbox cluster, so the commands are suited for that environment.
• Explore our YouTube Channel with short demo videos in this playlist

Ready to dive in? Run it yourself.

We love when the community gets involved! There are two main ways you can contribute:

Contribute to Existing Libraries

Our troubleshooting library is fully open-source and welcomes contributions. You can contribute directly to these repositories:

• RunWhen CLI Codecollection

For more details, check out the contribution guides within each repo.

Create Your Own Library

Interested in maintaining your own code collection and being rewarded for your efforts? Learn more about the RunWhen Author Program.

Share New Commands or Enhance Existing Ones

Join the community by:

• Contributing an awesome troubleshooting command
• Requesting a new command
• Engaging in discussions on GitHub Discussions.

Your ideas matter! Help us enhance the tool:

• Report bugs or share feedback
• Want to make your own changes? Read the CONTRIBUTING documentation, fork the repo, and explore the DEVELOPMENT documentation.

We're a friendly bunch! Connect with us on:

• Slack

All documentation is stored in /docs, but is also rendered by GitBook here.

• User Guide
• Architecture
• Development

We've got exciting plans ahead! Here's a sneak peek at what's coming:

• Introducing indexers for various cloud resources (GCP, AWS, Azure)
• Streamlining the tool's size & complexity by removing Neo4j

We're also working on:

• Robust CI/CD: Sandbox deployment validation for PRs
• Expanding our library of troubleshooting commands (always more to come!)
• Improved contribution guides
• Detailed low-level documentation

In the meantime, we're constantly adding features and troubleshooting code. Feel free to raise issues for new features or contribute your own commands!

Check out the GitHub Project for ongoing roadmap updates.

Catch up on our latest updates in the release notes.

Welcome to RunWhen Local – your go-to troubleshooter's companion! 🚀