README.md

rust-code-analysis-tui

A TUI (Text User Interface) for visualizing Rust project analysis generated by rust-code-analysis.

---

Prerequisites

Before using this tool, you must analyze your project using rust-code-analysis.

Recommended command:

rust-code-analysis --paths <project_path> -m -c --pr -O json -o <analysis_destination_path>

Once the analysis is complete, you can use this TUI tool to explore the results.

---

Usage

Run the following command:

./rust-code-analysis-tui <analysis_destination_path>

Inside the TUI, you can browse directories and view a summary report based on rust-code-analysis JSON files.

⚠️ Warning:
Directory navigation within the TUI is not yet supported. If you need to analyze a different path, you must exit and restart the tool with the new directory path.

ℹ️ Note for macOS users:
You may encounter issues due to app signature restrictions. To resolve this, run:

xattr -d com.apple.quarantine ./rust-code-analysis-tui

Then, restart the tool.

---

Building from Source

To compile the project yourself, run:

cargo build --release

---

Contributing

Contributions are welcome! Feel free to fork the repository and submit a pull request. For major changes, please open an issue first to discuss what you would like to change.

Please follow Conventional Commits, which allows our project to have beautiful changelogs based on your commit messages. We strongly encourage you to install Cocogitto:

cargo install cocogitto cargo-edit
cog install-hook --all