mirror of
https://github.com/bellingcat/octosuite.git
synced 2026-06-08 03:18:35 +03:00
64 lines
1.6 KiB
Markdown
64 lines
1.6 KiB
Markdown
# OctoSuite
|
|
|
|
TUI-based toolkit for GitHub data analysis.
|
|
|
|
## Overview
|
|
|
|
OctoSuite provides a terminal interface for exploring and exporting GitHub data. Access information about users,
|
|
repositories, organizations, and search across GitHub's platform.
|
|
|
|
## Features
|
|
|
|
- **User Data** - View profiles, repositories, followers, organizations, and activity, e.t.c.
|
|
- **Repository Data** - Access repository details, commits, issues, releases, and contributors
|
|
- **Organisation Data** - Explore organisation profiles, members, and repositories
|
|
- **Search** - Search across repositories, users, commits, issues, and topics
|
|
- **Export** - Save data in JSON, CSV, or HTML formats
|
|
|
|
## Installation
|
|
|
|
### PyPI
|
|
|
|
```bash
|
|
pip install octosuite
|
|
```
|
|
|
|
### Build from source
|
|
|
|
```bash
|
|
# Clone repository
|
|
git clone https://github.com/bellingcat/octosuite.git
|
|
|
|
# Move to octosuite directory
|
|
cd octosuite
|
|
|
|
# Build and install (uses uv)
|
|
make install
|
|
|
|
# If you dont have uv installed, you can install directly with pip:
|
|
pip install .
|
|
|
|
# Run
|
|
octosuite
|
|
```
|
|
|
|
> [!Note]
|
|
> You can run octosuite with commands `octosuite`, or `ocs`
|
|
|
|
## Usage
|
|
|
|
Navigate using <kbd>↑</kbd><kbd>↓</kbd> and <kbd>Enter</kbd> to select options. The interface guides you through
|
|
selecting a
|
|
data source
|
|
and
|
|
choosing what information to retrieve. Preview the results and optionally export them in your preferred format.
|
|
|
|
## License
|
|
|
|
### MIT License
|
|
|
|
See the LICENSE file for details. License information is also available through the application's main menu.
|
|
|
|
## Contributing
|
|
|
|
Contributions are welcome. Please submit pull requests or open issues for bugs and feature requests. Good luck! |