amittell/askrepo

โ˜… 0Forks 0GitHub โ†—Compare

README

๐Ÿค– AskRepo - AI Code Assistant for macOS

AskRepo Icon Swift macOS License

A beautiful, modern macOS app that helps you prepare code for AI assistants

Download DMG โ€ข Features โ€ข Install โ€ข Contribute

If AskRepo helps your workflow, consider giving it a โญ and following me on X @ @flashloanz.

โœจ Features

AskRepo streamlines the process of sharing your codebase with AI assistants like ChatGPT, Claude, Gemini or Grok. Instead of manually copying and pasting files, AskRepo provides an elegant solution:

๐ŸŽฏ Smart File Selection

  • Visual File Tree: Navigate your project structure with an intuitive file explorer
  • Selective Inclusion: Choose exactly which files to include using checkboxes
  • GitIgnore Aware: Automatically respects .gitignore patterns

๐Ÿ“Š Token Management

  • Real-time Token Counting: See total tokens for your selection
  • Per-file Token Display: Individual token counts for each selected file

๐ŸŽจ Beautiful Interface

  • Modern Design: Clean, native macOS design language
  • Smooth Animations: Delightful interactions throughout

๐Ÿš€ Productivity Features

  • Customizable Prompt Templates: Save and reuse prompt templates for different AI assistants
  • One-Click Copy: Copy formatted output directly to clipboard
  • Persistent Sessions: Remembers your directory selections
  • Custom Prompts: Add context and instructions for AI
  • Confirmation Dialogs: Prevents accidental data loss

๐Ÿ”’ Privacy First

  • Local Processing: All operations happen on your machine
  • No Network Calls: Your code never leaves your computer
  • Open Source: Full transparency in how your data is handled

๐Ÿ“ฑ Screenshots

AskRepo Main Interface Main interface showing file selection and prompt composition


๐Ÿ’พ Installation

Option 1: Download DMG (Recommended)

  1. Download the latest AskRepo.dmg
  2. Open the DMG file
  3. Drag AskRepo to your Applications folder
  4. Launch AskRepo from Applications or Spotlight

Option 2: Build from Source```bash

Clone the repository

git clone https://github.com/ninjiez/askrepo.git cd askrepo

Build and run

swift build swift run

Or open in Xcode

open Package.swift


### Requirements
- **macOS 13.0** or later
- **Xcode 15.0** or later (for building from source)

---

## ๐ŸŽฏ How to Use

### 1. **Add Your Projects**
Click the **+** button to add project directories. AskRepo will:
- Load the complete file structure
- Respect `.gitignore` patterns  
- Auto-select relevant code files

### 2. **Select Files**
- โœ… Check files you want to include
- ๐Ÿ“ Select entire directories with one click
- ๐Ÿ‘๏ธ See real-time token counts

### 3. **Write Your Prompt**
Add context in the prompt section:
```markdown
Please review this React component and suggest improvements for:
- Performance optimization
- Code readability  
- TypeScript best practices

4. Copy & Share

Click Copy to get formatted output ready for your AI assistant:

# Instructions

Please review this React component and suggest improvements...

# Selected Files

src/components/UserProfile.tsx
// Your code here...

src/hooks/useUser.ts
// More code...

๐Ÿ› ๏ธ Contributing

We'd love your help making AskRepo even better! Here's how you can contribute:

๐Ÿ› Report Issues

Found a bug? Open an issue with:

  • Clear description of the problem
  • Steps to reproduce
  • macOS version and AskRepo version
  • Screenshots if applicable

โœจ Suggest Features

Have an idea? Send me a DM or open a feature request!

๐Ÿ”ง Submit Code

  1. Fork the repository
  2. Create a feature branch: git checkout -b amazing-feature
  3. Make your changes
  4. Add tests if applicable
  5. Submit a pull request

๐Ÿ“‹ Development Setup

git clone https://github.com/ninjiez/askrepo.git
cd askrepo
swift build

Code Style: We follow Swift conventions and use SwiftUI best practices.


๐Ÿ—๏ธ Architecture

AskRepo is built with modern Swift technologies:

  • SwiftUI: Declarative UI framework
  • Swift Package Manager: Dependency management
  • Foundation: File system operations
  • AppKit: Native macOS integration

๐Ÿ“ˆ TODO

  • Dark Mode: Switch between light & dark mode
  • LLM API Integration: Directly send output to your chosen LLM API.
  • Plugin System: Extensible architecture
  • Windows/Linux: Cross-platform support
  • Prompt Prefix/Rules: Add rules that will be added to all prompts.

๐Ÿ’ฌ Community & Support

๐Ÿฆ Follow & Connect

  • Twitter/X: @flashloanz - Follow for updates, tips, and support!
  • GitHub: Star โญ this repo if you find it useful

๐Ÿค Get Involved

  • Share: Tell other developers about AskRepo
  • Feedback: Reach out on X with suggestions
  • Contribute: Check out good first issues

๐Ÿ“„ License

AskRepo is open source software licensed under the MIT License.

Copyright (c) 2025 @flashloanz

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software...

Made with โค๏ธ by @flashloanz

If AskRepo helps your workflow, consider giving it a โญ and following @flashloanz.

โฌ† Back to Top

Contributors

ninjiez

Issues