https://github.com/iamhectorsosa/octomap
🐙 Transform GitHub repositories into structured JSON for LLMs and AI-powered code analysis.
https://github.com/iamhectorsosa/octomap
ai cli golang llms
Last synced: 12 months ago
JSON representation
🐙 Transform GitHub repositories into structured JSON for LLMs and AI-powered code analysis.
- Host: GitHub
- URL: https://github.com/iamhectorsosa/octomap
- Owner: iamhectorsosa
- Created: 2024-12-13T16:51:38.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-20T16:09:44.000Z (over 1 year ago)
- Last Synced: 2025-02-09T13:13:58.215Z (over 1 year ago)
- Topics: ai, cli, golang, llms
- Language: Go
- Homepage:
- Size: 4.19 MB
- Stars: 11
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Octomap 🐙
Octomap is a CLI tool that transforms GitHub repositories into structured JSON, making repository content easily digestible for large language models (LLMs) and AI-powered code analysis.
Ideal for developers and data scientists looking to feed repository data directly into AI tools for code understanding, analysis, or transformation.
## Quick Overview
- **Structured JSON Output**: Convert repositories into JSON for further analysis or processing.
- **Pipeline Integration**: Use the `--stdout` flag to output results directly to `stdout`, enabling seamless integration with other tools.
- **Configurable Processing**:
- Include or exclude specific file types.
- Specify target branches and directories.
- **Reusable Logic**: Core logic is modularized in the `pkg` directory for easy reuse in other projects.
## Requirements
- Go 1.23.2 or later
- Git
## Installation
### Using Go Install
```bash
go install github.com/iamhectorsosa/octomap@latest
```
If you need to skip module proxy, you can use:
```bash
GOPROXY=direct go install github.com/iamhectorsosa/octomap@latest
```
### From Source
1. Clone the repository:
```bash
git clone https://github.com/iamhectorsosa/octomap.git
cd octomap
```
2. Build the project:
```bash
go build -o octomap
```
3. (Optional) Install the binary:
```bash
go install
```
## Usage
### Basic Usage
```bash
octomap user/repo
```
This command will download the main branch of the specified repository and generate a JSON file with its structure.
### Advanced Options
```bash
# Specify a different branch
octomap user/repo --branch develop
# Target a specific directory within the repository
octomap user/repo --dir src
# Include only specific file types
octomap user/repo --include .go,.proto
# Exclude specific file types
octomap user/repo --exclude .mod,.sum
# Specify a custom output directory
octomap user/repo --output ~/documents
# Print results to `stdout`
octomap user/repo --stdout
```
### Flags
- `--dir`: Target directory within the repository
- `--branch`: Branch to clone (default: main)
- `--include`: Comma-separated list of included file extensions
- `--exclude`: Comma-separated list of excluded file extensions
- `--output`: Output directory for the generated JSON file
- `--stdout`: Print results to `stdout`. When this flag is used, the `output` flag is ignored.
## Development
### Setup
1. Clone the repository
2. Install dependencies:
```bash
go mod download
```
### Running Tests
```bash
go test ./...
```
### Building
```bash
go build
```