A fast, keyboard-driven TUI API client & webhook inspector. No cloud, no Electron, 100% local-first.
Contributing to Ghostman π»
Thank you for your interest in contributing to Ghostman! We welcome contributions, bug reports, and ideas from everyone.
π οΈ Development Setup
Fork and Clone the repository:
git clone https://github.com/4yk5/Ghostman.git cd GhostmanCreate a virtual environment (optional but recommended):
python -m venv venv # On Windows: venv\Scripts\activate # On macOS/Linux: source venv/bin/activateInstall dependencies:
pip install -r requirements.txtRun Ghostman locally:
python main.py
π§ͺ Running Tests
Before submitting a Pull Request, always make sure all tests pass cleanly:
python tests/test_all.py
π‘ How to Contribute
- Report Bugs: Open an issue using our Bug Report Template.
- Suggest Features: Have an idea? Submit a Feature Request.
- Submit Pull Requests:
- Fork the repo and create your branch from
main(git checkout -b feature/awesome-feature). - Keep code clean, readable, and follow the existing TUI architecture.
- Ensure all tests pass.
- Submit your Pull Request with a clear description of the changes!
- Fork the repo and create your branch from
π License
By contributing to Ghostman, you agree that your contributions will be licensed under the MIT License.