Satellite

A CLI assistant for exploring and understanding codebases using Google's Gemini API.

Features

• 🔍 Smart file filtering based on .gitignore, .aiignore, and .env* patterns
• 💬 Interactive chat interface to ask questions about your code
• 🌈 Syntax highlighting for code snippets in responses
• 🔒 Privacy-focused by keeping your code local and only sending to the Gemini API

Installation

You can install Satellite directly from npm:

# Install globally
npm install -g @raketa-cloud/satellite
# Then use the 'satellite' command directly
satellite --help

# Or run without installing
npx @raketa-cloud/satellite

From Source

# Clone the repository
git clone https://github.com/vestimir/satellite.git
cd satellite

# Install dependencies
npm install

# Install globally (optional)
npm install -g .

Usage

# Basic usage
satellite [directory]

# Show help
satellite --help

# Skip confirmation prompts
satellite --yes

# Run in offline mode (for testing without an API key)
satellite --offline

Requirements

• Node.js v16 or higher
• Google Gemini API key (set as GEMINI_API_KEY environment variable)

Setting Up Your API Key

# Set your API key (replace YOUR_API_KEY with your actual key)
export GEMINI_API_KEY=YOUR_API_KEY

You can get a Gemini API key from Google AI Studio.

Options

• --help, -h: Show help message
• --version, -v: Show version information
• --verbose: Show more detailed output
• --yes, -y: Skip confirmation prompts
• --offline: Run in offline mode (skip API connection)
• --env-only: Only use .env* file filtering
• --skip-gitignore: Skip .gitignore file filtering
• --skip-aiignore: Skip .aiignore file filtering
• --skip-env-filter: Skip automatic .env* file filtering

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Releasing

This project uses GitHub Actions to automatically publish to npm when a new GitHub Release is created:

1. Update the version in package.json
2. Commit your changes and push to GitHub
3. Create a new GitHub Release with a semantic version tag (e.g., v1.0.1)
4. The GitHub Action will automatically publish the new version to npm

License

ISC