An open API service indexing awesome lists of open source software.

https://github.com/neuwcodebox/starseeker

A CLI tool to search your starred GitHub repositories using natural language
https://github.com/neuwcodebox/starseeker

Last synced: 4 months ago
JSON representation

A CLI tool to search your starred GitHub repositories using natural language

Awesome Lists containing this project

README

          

# ⭐ Starseeker

StarSeeker is a CLI tool to search your starred GitHub repositories using natural language.

![demo](./docs/demo.png)

## Features

- Index your starred GitHub repositories via the GitHub API
- Natural language repository search powered by Ollama
- Configuration management (GitHub PAT, Ollama settings, embedding models, etc.)

## Installation

```bash
npm install -g starseeker
```

## Usage

### Configuration

Before using StarSeeker, you need to set up a few configurations:

```bash
starseeker init
```

To make each setting yourself, see the following.

#### Set GitHub Personal Access Token (Required)

```bash
# https://github.com/settings/personal-access-tokens
starseeker config set pat
```

![pat](./docs/pat.png)

#### Ollama Configuration (Optional)

```bash
# Set Ollama host
starseeker config set ollama host

# Set Ollama API key (if required)
starseeker config set ollama key
```

#### Embedding Model Configuration (Required)

```bash
# First install Ollama and download an embedding model you want
starseeker config set embed model
```

### View Current Configuration

```bash
# View GitHub PAT
starseeker config get pat

# View Ollama host
starseeker config get ollama host

# View Ollama API key
starseeker config get ollama key

# View embedding model
starseeker config get embed model
```

### Indexing Repositories

Index your starred GitHub repositories:

```bash
# This may take a while, and you can interrupt(Ctrl+C) it along the way.
starseeker index --batch 4
```

### Searching Repositories

Search your indexed repositories using natural language:

```bash
# Basic search (returns top 5 results by default)
starseeker search image processing library

# Specify number of results
starseeker search TypeScript ORM with PostgreSQL support --k 10
```

### Clear Indexed Repositories

```bash
starseeker db clear
```

## Requirements

- GitHub Personal Access Token
- Access to Ollama and an embedding model

## License

MIT

## Contributing

Issues and pull requests are welcome.