Metadata-Version: 2.4
Name: cli-cmdr
Version: 0.1.0
Summary: A CLI tool for version controlled aliases inspired by dbt selectors
Home-page: https://github.com/cli-commander/cli-commander
Author: cli-commander
License: MIT
Project-URL: Homepage, https://github.com/cli-commander/cli-commander
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: PyYAML>=5.1
Dynamic: home-page
Dynamic: license-file
Dynamic: requires-python

# cli-commander

A CLI tool for version controlled aliases inspired by dbt selectors.

## Installation

Install via pip:

```bash
pip install cli-commander
```

Or install from source:

```bash
git clone https://github.com/cli-commander/cli-commander.git
cd cli-commander
pip install -e .
```

## Usage

### Configuration

cli-command looks for a configuration file named `cli-commander.yml` in either:
- Your current directory (`.`), or
- Your home directory (`~/.cli-commander/`)

The tool will check the local directory first, then fall back to the home directory.

You can autocreate this with a template by running:

```
cmdr init
```

### Configuration Format

```yaml
selectors:
  selector-name:
    description: "Description of what this command does"
    command: "command to execute"
```

### Example Configuration

```yaml
selectors:
  test:
    description: "Run all tests"
    command: "pytest"
  
  build:
    description: "Build the project"
    command: "python setup.py build"
  
  lint:
    description: "Lint code with flake8"
    command: "flake8 ."
```

### Running Commands

Execute a selector using the `cmdr` command:

```bash
cmdr <selector-name>
```

For example:

```bash
cmdr test
cmdr build
cmdr lint
```

### List Available Selectors

To see all available selectors from your configuration:

```bash
cmdr --list
```

## License

MIT License - see LICENSE file for details.
