seiri (整理)

A platform-agnostic project visualization tool.

Overview

seiri breaks down project structures into a common format that can be used by developers and AI alike to better understand the design of large codebases.

Features

• Explores system structure and dependencies visually
• Extracts modules, imports, functions, and containers
• Uses tree-sitter for fast, incremental parsing

Installation

You can find our pre-built binaries under the Releases tab to download.

Using cargo

If you are using cargo, you can run the following to install it globally:

cargo install seiri-cli

Build from Source

If you want to build from source, clone the repository and make sure to install the Rust toolchain. Then you can run the following commands:

cargo build --release
./target/release/seiri <options>

Usage

Provide a path to the project you want to analyze, and optionally specify to produce a visualization and/or an image file containing all extracted information.

seiri <path> [gui|<export_path>] [-v|--verbose]

• <path> - File or directory to analyze
• gui - Launch visualization
• <export_path> - Export graph to specified path; currently supports SVG, PNG, and JPEG file exports
• -v/--verbose - Show detailed logging about file detection and parsing
• --no-gitignore - Do not respect .gitignore file if present
• --update - Update the binary to the latest GitHub release

Supported Languages

• Rust
• Python
• TypeScript
• C++

Contributing

Contributions are greatly appreciated! :)

Make sure to follow the guidelines laid out in CONTRIBUTING.md.

License

MIT License