repo

command module
v0.0.0-...-af000dd Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 17, 2024 License: MIT Imports: 4 Imported by: 0

README

Repo

repo is a cli application to organise scm repositories in a structured hierarchy.

For example, github.com/microhod/repo.git would be stored at ~/src/github.com/microhod/repo.

Usage

Run repo --help to see full CLI usage.

NAME:
   repo - A cli application to organise scm repositories in a structured heirachy

USAGE:
   repo [global options] command [command options] [arguments...]

COMMANDS:
   clone     clone a repo
   organise  organise all repos under the current path into a structured heirachy
   help, h   Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --help, -h  show help (default: false)

Install

Compile from Source
  • Install golang 1.22 or later
  • Run go install github.com/microhod/repo@latest to download and install the binary (this will install to ~/go/bin)

Config

Configuration will be auto-generated at first startup and stored at ~/.config/repo/config.json.

The default configuration is as below:

{
    "remote": {
        "default": {
            "prefix": "ssh://git@github.com"
        }
    },
    "local": {
        "root": "~/src"
    }
}

Todo

  • More complete docs
  • Tests!!!
  • --dry-run option for organise
  • --verbose option for all commands
  • add profile command generate terminal profile for utlity commands

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
internal
cli
Package cli describes the command line application
Package cli describes the command line application
config
Package config contains code for config parsing
Package config contains code for config parsing
domain
Package domain contains all the specific objects related to the application
Package domain contains all the specific objects related to the application
path
Package path deals with local file paths
Package path deals with local file paths
scm
Package scm deals with source code management systems
Package scm deals with source code management systems
terminal
Package terminal deals with terminal operations like progress and profiles
Package terminal deals with terminal operations like progress and profiles

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL