rkit

A minimal, high-performance CLI suite written in Rust for organizing, scanning, and inspecting Git repositories under a user-defined workspace.

Features

• clone: Smart Git clone wrapper that organizes repositories by domain and organization
• ls: List all Git repositories in your workspace
• view: View repository information and metadata

Installation

cargo install rkit

Configuration

The configuration file is located at:

• Unix-like systems: ~/.config/rkit/config.yaml
• Windows: %APPDATA%\rkit\config.yaml

It will be created automatically on first run with platform-specific default values.

Default Configuration

The default configuration includes:

# Linux/macOS
project_root: ~/projects
rview:
  - command: basename {REPO}
    label: Repo
  - command: git -C {REPO} rev-parse --abbrev-ref HEAD
    label: Active Branch
  - command: git -C {REPO} status
    label: Status
  - command: cat {REPO}/README.md
    label: README

# Windows
project_root: %USERPROFILE%\projects
rview:
  - command: powershell -Command "Split-Path -Leaf {REPO}"
    label: Repo
  - command: git -C {REPO} rev-parse --abbrev-ref HEAD
    label: Active Branch
  - command: git -C {REPO} status
    label: Status
  - command: type {REPO}\README.md
    label: README

Usage

Clone a repository

rkit clone https://github.com/username/repo.git

This will clone the repository to ~/projects/github.com/username/repo (or %USERPROFILE%\projects\github.com\username\repo on Windows).

List repositories

rkit ls [--full]

Lists all Git repositories found under the configured project root. Use the --full flag to show absolute paths instead of relative paths.

View repository information

rkit view path/to/repo

Displays repository information based on configured commands. The command will:

• Show the repository name
• Display the active branch
• Show the current git status
• Display the repository's README.md if available
• Fall back to directory listing if no README is found

Development

# Build
cargo build

# Run tests
cargo test

# Run with debug output
RUST_LOG=debug cargo run -- ls

# Run with trace output
RUST_LOG=trace cargo run -- ls

The project uses structured logging with different verbosity levels:

• info: Default level, shows basic operations
• debug: Shows detailed operation information
• trace: Shows all internal operations

License

MIT