โ๏ธ Deploy your own
โจ Features
- Concurrent Engine: Scans 14+ toolchains (Homebrew, npm, Cargo, Docker, etc.) in parallel.
- Interactive TUI: Features custom pie charts, health gauges, and quick keyboard navigation.
- Project Tooling Sector: Deep-dives into local lockfiles, dependency drift, and security audits.
- CLI Reports: Generates production-ready Markdown reports instantly for CI/CD or PRs.
- Smart Cache: Zero-friction launches utilizing local JSON state (
~/.envexa/cache.json).
๐งฑ Tech Stack
- React: UI framework for declarative component rendering.
- TanStack Router: Declarative client-side routing with nested layouts.
- TypeScript: Strong typing for safer maintenance and refactoring.
- Tailwind: Utility-first styling used across components.
- Shadcn UI: Base design primitives for consistent interface components.
๐ Getting Started
Clone the repo, install deps, and boot the dev server:
git clone https://github.com/KurutoDenzeru/Ketch.git
cd Ketch
bun install
bun run dev
Open http://localhost:3000 to view the app.
๐ฆ Build for Production
bun run build
bun start
๐๏ธ Configuration
The app is implemented under src/. Key areas to customize and extend are:
envexa/
โโโ Cargo.toml
โโโ src/
โ โโโ main.rs # Application entrypoint (TUI or CLI router)
โ โโโ cli.rs # CLI command parser and runner
โ โโโ config.rs # Persistent configurations and cached state
โ โโโ scanner/
โ โ โโโ mod.rs # Formatting utilities and diagnostic extraction
โ โโโ tui/
โ โ โโโ app.rs # App state management, keyboard events, and scheduler
โ โ โโโ mod.rs
โ โ โโโ ui.rs # Ratatui rendering pipeline and interface structures
โ โโโ toolchains/
โ โโโ mod.rs # ScanResult schema, protocols, and multi-thread runners
โ โโโ brew.rs
โ โโโ npm.rs / pnpm.rs / yarn.rs / bun.rs / deno.rs
โ โโโ pip.rs / gem.rs / cargo.rs / docker.rs
โ โโโ project.rs / security.rs / audit.rs / ci.rs
โโโ scripts/
โ โโโ install.sh
โ โโโ build-and-upload.sh
โโโ .github/
โโโ workflows/
๐ค Contributing
Contributions are always welcome, whether youโre fixing bugs, improving docs, or shipping new features that make the project better for everyone.
Check out Contributing.md to learn how to get started and follow the recommended workflow.
โ๏ธ License
This project is released under the MIT License, giving you the freedom to use, modify, and distribute the code with minimal restrictions.
For the full legal text, see the MIT file.