- README.md — Installation, usage, configuration reference, and project overview.
- configs/warpshift.example.toml — Annotated example configuration with all available settings.
For general questions about usage, configuration, or development:
- Open a GitHub Discussion if enabled, or
- Open a GitHub Issue with the question label.
Found a bug? Open a GitHub issue with:
- A clear description of the problem.
- Steps to reproduce.
- Expected behavior vs. actual behavior.
- Your environment:
- OS and version (e.g., Ubuntu 24.04, macOS 15, Windows 11)
- Go version (
go version) - WarpShift-TUI version (
./build/warpshift version) - Relevant config excerpts (redact secrets)
- Any error messages or log output.
Do not file public issues for security vulnerabilities.
See SECURITY.md for the private reporting process.
Feature requests are welcome as GitHub issues. Before submitting:
- Check existing issues to avoid duplicates.
- Describe the use case and why it matters.
- Keep requests focused — one feature per issue.
See CONTRIBUTING.md for development setup, code style, and pull request guidelines.