Metadata-Version: 2.4
Name: kick-runner
Version: 0.1.1
Summary: Config-driven launcher for project bundles and reusable shell command groups.
Author: Thomas
License-Expression: MIT
Project-URL: Homepage, https://github.com/Tomax47/Kick
Project-URL: Repository, https://github.com/Tomax47/Kick
Project-URL: Issues, https://github.com/Tomax47/Kick/issues
Project-URL: Documentation, https://github.com/Tomax47/Kick#readme
Project-URL: PyPI, https://pypi.org/project/kick-runner/
Keywords: cli,launcher,projects,bundles,terminal,devtools
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: Utilities
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# Kick

Config-driven launcher for project bundles and reusable shell command groups.

- **PyPI:** [kick-runner](https://pypi.org/project/kick-runner/)
- **Source:** [github.com/Tomax47/Kick](https://github.com/Tomax47/Kick)

## Install

```bash
pipx install kick-runner
# or
pip install kick-runner
```

## Setup

```bash
kick init
```

This creates config files (from examples) in `./config` when run from a checkout, or in `~/.config/kick` otherwise. Edit:

- `settings.yml` — work root, terminal, update commands
- `aliases.yml` — reusable shell snippets and `kick <group> <command>` recipes
- `projects.yml` — projects and bundles

Copy from the templates in [`config/*.yml.example`](config/) if you prefer to do it by hand.

## Usage

```bash
kick list projects
kick list bundles
kick list commands
kick list aliases

kick up example-app
kick up app --latest
kick bundle work
kick bundle work -l

kick hello world
kick git task feature/my-branch
kick --dry-run bundle work -l
```

`-l` / `--latest` runs `update_run` from settings when the project git tree is clean.

## Config location

1. `--config-dir` or `KICK_CONFIG_DIR`
2. `./config` if `./config/projects.yml` exists
3. `~/.config/kick` (seeded on first use)

## License

MIT
