Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mohitsinghs/repo
A command line tool to jump between repositories with ease
https://github.com/mohitsinghs/repo
cli command-line command-line-tool repository-management zsh
Last synced: 12 days ago
JSON representation
A command line tool to jump between repositories with ease
- Host: GitHub
- URL: https://github.com/mohitsinghs/repo
- Owner: mohitsinghs
- License: mit
- Created: 2022-04-20T08:52:24.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-19T08:39:45.000Z (3 months ago)
- Last Synced: 2024-10-15T12:10:01.195Z (24 days ago)
- Topics: cli, command-line, command-line-tool, repository-management, zsh
- Language: Rust
- Homepage:
- Size: 136 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
repo
Switch between repositories with ease
Access all repositories from anywhere
## Features
- **Fuzzy matching** - can match paths partially.
- **Shell integration** - Works with zsh, bash and fish.
- **Output formats** - supports plain and nested json output.
- **Respects gitignore** - skips nested repositories that are ignored by git.
- **Configurable** - you can add multiple roots and control scan depth for each.
## Demo
## Installing
Download [latest release](https://github.com/mohitsinghs/repo/releases/latest) for your system and put it in the path.
## Outputs
| Command | Output Type | Description |
| -------------------- | ----------- | ------------------------------------------ |
| `repo cmp` | Text | repository names separated by space |
| `repo cmp -f/--full` | Text | full repository paths separated by newline |
| `repo cmp -j/--json` | JSON | paths and other metadata as a list |
| `repo cmp -t/--tree` | JSON | paths and other metadata as a tree |
## Shell integration
You can run `repo sh` to see the setup instructions for your current shell if supported. Supported shells are `zsh`, `bash` and `fish`.
## Usage
You can jump around your repos with -
```bash
% z fo/ba
% /foo/bar
% z p/os/vsc
% ~/Projects/oss/vscode-repo
```
Where `z` can be any letter you bind. Hitting the tab will show you possible locations.
## Editor Integration
- **Neovim** - [repo.nvim](https://github.com/mohitsinghs/repo.nvim) is a neovim plugin that uses [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim).
- **VSCode** - [vscode-repo](https://github.com/mohitsinghs/vscode-repo) can be installed from the [marketplace](https://marketplace.visualstudio.com/items?itemName=mohitsingh.repo) or from the `vsix` files under releases.
## Configuration
You can customize the behavior of repo by creating a configuration file named `repo.yml`.
> [!TIP]
> If no repo.yml file exists, the tool will search your home directory by default.
### 1. Initializing Config
To initiate a blank configuration file, execute the following command:
```sh
repo init
```
This creates the `repo.yml` file in your system's default configuration directory.
### 2. Specifying Root Paths
> [!WARNING]
> Ensure paths are specified using the correct path syntax for your operating system.
Define the directories you wish to include in the search. Each path can optionally specify a maximum traversal depth:
```yaml
roots:
# Search all Git repositories within this directory:
- path: /home/mohit/Projects
# Restrict the search to a depth of 2 levels within this directory:
- path: /home/mohit/Work
depth: 2
```