findra

A simple and fast repository management CLI tool written in Gleam.

🚀 How to use

Initialize the default directory (~/.findra):

findra init

Clone a Git repository or create a directory:

# Clone a Git repository
findra get https://github.com/user/repo

# Create a new directory
findra get myproject

List all managed directories:

findra list

Show the root directory path:

findra root

⬇️ Install

From Releases

Download the latest AppImage from the releases page:

# Download and make executable
chmod +x findra.AppImage

# Move to a directory in your PATH
mv findra.AppImage ~/.local/bin/findra

From Source

Requirements:

• Gleam (>= 0.44.0)
• Erlang/OTP

Build from source:

# Clone the repository
git clone https://github.com/Comamoca/findra
cd findra

# Build the project
gleam build

# Run
gleam run

With Nix

If you have Nix with flakes enabled:

# Run directly
nix run github:Comamoca/findra

# Or build
nix build

⛏️ Development

Prerequisites

• Gleam (>= 0.44.0)
• Erlang/OTP
• Git

Setup

# Clone the repository
git clone https://github.com/Comamoca/findra
cd findra

# Install dependencies (automatically handled by Gleam)
gleam build

Running Tests

gleam test

Development with Nix

If using Nix with flakes:

# Enter development shell
nix develop

# Build
gleam build

# Run
gleam run

📝 Todo

• Add configuration file support (.findrarc)
• Support for custom directory structures
• Add command to search repositories
• Integration with fzf for interactive selection
• Add update command for repositories

📜 License

MIT License (to be added)

🧩 Modules

findra uses the following Gleam packages:

• gleam_stdlib - Gleam standard library
• simplifile - File system operations
• filepath - Cross-platform file path handling
• argv - Command-line argument parsing
• xdgleam - XDG Base Directory support
• snag - Error handling
• shellout - Shell command execution
• glap - CLI argument parser
• gleeunit - Testing framework (dev dependency)

👏 Affected projects

This project was inspired by:

• ghq - Remote repository management made easy
• Repository management tools in general that help organize development projects

💕 Special Thanks

Special thanks to:

• The Gleam team for creating an amazing language
• All the contributors of the Gleam packages used in this project
• The open-source community for inspiration and support