Metadata-Version: 2.1
Name: carefree-cli
Version: 0.1.1
Summary: A `cli` that helps you manage your `cli` commands
Home-page: https://github.com/carefree0910/carefree-cli
Download-URL: https://github.com/carefree0910/carefree-cli/archive/v0.1.1.tar.gz
Author: carefree0910
Author-email: syameimaru.saki@gmail.com
Keywords: python cli
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: rich
Requires-Dist: regex
Requires-Dist: typer
Requires-Dist: filelock
Requires-Dist: pydantic

A `cli` that helps you manage your `cli` commands.

## Design

Basically, `carefree-cli` aims to help you when:

- you need to run lots of `cli` commands everyday.
- these commands can be divided into several groups, and commands in each group are highly repetitive.

So the implementation of `carefree-cli` is very simple:

- It will prompt you to create `cli` command templates and manage them in hierarchical structures.
- It will prompt you to 'fill' the template with your own parameters when you want to run a command.
- It will printed out the final command for you to copy-paste / run.

## Installation

`carefree-cli` requires `python>=3.8`.

```bash
pip install carefree-cli
```

## Basic Workflow

1. Initialize `carefree-cli`:

```bash
cfi init
```

2. Create a `cli` template:

```bash
cfi add -h
```

3. Fill a `cli` template:

```bash
cfi load -h
```

## Common Usages

> Fun fact: you can add `cfi` templates with `carefree-cli` itself!
>
> ```bash
> cfi add 'cfi add \"{template}\" {hierarchy}' cfi_add
> ```

- Get help:

```bash
cfi -h
```

- Install cli completion:

```bash
cfi --install-completion
```

- List templates:

```bash
cfi list -h
```

## Serializations

- Export templates:

```bash
cfi export
```

- Import templates:

```bash
cfi import -h
```
