A `cli` that helps you manage your commands.
## Design
Basically, `carefree-cli` aims to help you when:
- you need to run lots of (`cli` / `bash`) 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` / `bash`) 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 command template:
```bash
cfi add -h
```
3. Fill a command 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 ls -h
```
## Serializations
- Export templates:
```bash
cfi export
```
- Import templates:
```bash
cfi import -h
```
## Documentation
An auto-generated documentation is available [here](https://github.com/carefree0910/carefree-cli/blob/main/docs.md).
> ```bash
> typer cfi utils docs --name cfi --output docs.md --title '`carefree-cli`'
> ```
Raw data
{
"_id": null,
"home_page": "https://github.com/carefree0910/carefree-cli",
"name": "carefree-cli",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "python cli",
"author": "carefree0910",
"author_email": "syameimaru.saki@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/20/d0/0333de81b33b15f82ea33b1d01a11a81d527e9e3f3309da0e8bd8e5d7c69/carefree_cli-0.1.2.tar.gz",
"platform": null,
"description": "A `cli` that helps you manage your commands.\r\n\r\n## Design\r\n\r\nBasically, `carefree-cli` aims to help you when:\r\n\r\n- you need to run lots of (`cli` / `bash`) commands everyday.\r\n- these commands can be divided into several groups, and commands in each group are highly repetitive.\r\n\r\nSo the implementation of `carefree-cli` is very simple:\r\n\r\n- It will prompt you to create (`cli` / `bash`) command templates and manage them in hierarchical structures.\r\n- It will prompt you to 'fill' the template with your own parameters when you want to run a command.\r\n- It will printed out the final command for you to copy-paste / run.\r\n\r\n## Installation\r\n\r\n`carefree-cli` requires `python>=3.8`.\r\n\r\n```bash\r\npip install carefree-cli\r\n```\r\n\r\n## Basic Workflow\r\n\r\n1. Initialize `carefree-cli`:\r\n\r\n```bash\r\ncfi init\r\n```\r\n\r\n2. Create a command template:\r\n\r\n```bash\r\ncfi add -h\r\n```\r\n\r\n3. Fill a command template:\r\n\r\n```bash\r\ncfi load -h\r\n```\r\n\r\n## Common Usages\r\n\r\n> Fun fact: you can add `cfi` templates with `carefree-cli` itself!\r\n>\r\n> ```bash\r\n> cfi add 'cfi add \\\"{template}\\\" {hierarchy}' cfi_add\r\n> ```\r\n\r\n- Get help:\r\n\r\n```bash\r\ncfi -h\r\n```\r\n\r\n- Install cli completion:\r\n\r\n```bash\r\ncfi --install-completion\r\n```\r\n\r\n- List templates:\r\n\r\n```bash\r\ncfi ls -h\r\n```\r\n\r\n## Serializations\r\n\r\n- Export templates:\r\n\r\n```bash\r\ncfi export\r\n```\r\n\r\n- Import templates:\r\n\r\n```bash\r\ncfi import -h\r\n```\r\n\r\n## Documentation\r\n\r\nAn auto-generated documentation is available [here](https://github.com/carefree0910/carefree-cli/blob/main/docs.md).\r\n\r\n> ```bash\r\n> typer cfi utils docs --name cfi --output docs.md --title '`carefree-cli`'\r\n> ```\r\n",
"bugtrack_url": null,
"license": null,
"summary": "A `cli` that helps you manage your commands",
"version": "0.1.2",
"project_urls": {
"Download": "https://github.com/carefree0910/carefree-cli/archive/v0.1.2.tar.gz",
"Homepage": "https://github.com/carefree0910/carefree-cli"
},
"split_keywords": [
"python",
"cli"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "20d00333de81b33b15f82ea33b1d01a11a81d527e9e3f3309da0e8bd8e5d7c69",
"md5": "e589ccdafa6973b9474ee12683b081d6",
"sha256": "d526b0a202c91250c3e1b70a9d2182294d24bd9a6098e1db8d6fff83a85797c3"
},
"downloads": -1,
"filename": "carefree_cli-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "e589ccdafa6973b9474ee12683b081d6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 8217,
"upload_time": "2024-10-10T04:36:14",
"upload_time_iso_8601": "2024-10-10T04:36:14.208331Z",
"url": "https://files.pythonhosted.org/packages/20/d0/0333de81b33b15f82ea33b1d01a11a81d527e9e3f3309da0e8bd8e5d7c69/carefree_cli-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-10 04:36:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "carefree0910",
"github_project": "carefree-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "carefree-cli"
}
JSON
