Metadata-Version: 2.1
Name: git-clode
Version: 0.2.0
Summary: CLI tool to open git repositories quickly
Author: Oli
Author-email: Oli <oli@olillin.com>
Maintainer-email: Oli <oli@olillin.com>
License: MIT License
        
        Copyright (c) 2024 olillin
        
        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, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Bug Reports, https://github.com/olillin/clode/issues
Project-URL: Source, https://github.com/olillin/clode
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: colorama
Requires-Dist: inquirer

# clode

CLI tool to open git repositories quickly.

## Installation

```console
pip install git-clode
```

## Usage

```console
$ clode -h
usage: clode [-h] [-n | -a] [-q | -l] repository [directory]

CLI tool to open git repositories quickly

positional arguments:
  repository         url or name of repository to clone
  directory          the name of a new directory to clone into

options:
  -h, --help         show this help message and exit
  -n, --never-open   don't open after cloning
  -a, --always-open  open even if already cloned
  -q, --search       search for a repository on GitHub
  -l, --lazy         lazy search for a repository on GitHub
```

## Examples

### Clode with URL

```console
$ clode https://github.com/olillin/clode
Cloning https://github.com/olillin/clode
```

### Clode with owner and repository name only

```console
$ clode olillin/clode
Cloning https://github.com/olillin/clode
```

> [!NOTE]
> The default service is GitHub. This can be changed in settings.
<!-- TODO: Add settings file name -->

### Clode with repository name only

```console
$ clode clode
Cloning https://github.com/olillin/clode
```

> [!NOTE]
> Requires a default user to be configured in settings
<!-- TODO: Add settings file name -->

### Clode with GitHub search query

```console
$ clode -q "org:cthit in:name hubbit"
[?] Select repository to clone:
 > cthit/hubbit
   cthit/hubbIT-old
```

### Clode with lazy search

```console
$ clode -l "cthit/chalmers it"
[?] Select repository to clone:
 > cthit/chalmers.it
   cthit/digit.chalmers.it
   cthit/chalmers.it-deprecated
   cthit/Avtal.chalmers.it

$ clode -l cals
Cloning https://github.com/olillin/cals-cals
```
