https://github.com/fpgmaas/ckit
A command line utility to help you organise and quickly run frequently used commands.
https://github.com/fpgmaas/ckit
bash cli command-line commands python shell
Last synced: 11 months ago
JSON representation
A command line utility to help you organise and quickly run frequently used commands.
- Host: GitHub
- URL: https://github.com/fpgmaas/ckit
- Owner: fpgmaas
- License: mit
- Created: 2022-12-20T14:33:36.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-27T10:19:20.000Z (about 3 years ago)
- Last Synced: 2025-07-11T22:06:19.096Z (11 months ago)
- Topics: bash, cli, command-line, commands, python, shell
- Language: Python
- Homepage: https://fpgmaas.github.io/ckit
- Size: 1.67 MB
- Stars: 65
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.rst
- License: LICENSE
Awesome Lists containing this project
README
---
[](https://img.shields.io/github/v/release/fpgmaas/ckit)
[](https://github.com/fpgmaas/ckit/actions/workflows/main.yml?query=branch%3Amain)
[](https://pypi.org/project/ckit/)
[](https://codecov.io/gh/fpgmaas/ckit)
[](https://pypistats.org/packages/ckit)
[](https://img.shields.io/github/license/fpgmaas/ckit)
_ckit_ is a command line utility to help you organise and quickly run frequently used commands.
---
Documentation - Example configuration files
---
## Quickstart
### Installation
_ckit_ can be installed by running
```shell
pip install ckit
```
To get started, run
```bash
ckit init
```
which will prompt to add a `ckit/ckit.yaml` file in the user's home directory for global commands, and/or a `ckit.yaml` file in the current directory for commands specific to the current project. Alternatively, run
```bash
ckit init --download-global-defaults
```
to get started with a richer set of examples in the global configuration directory, see [ckit-files](https://github.com/fpgmaas/ckit-files/).
To use _ckit_ to run any of the pre-configured commands, simply run
```
ckit
```
## Configuration
_ckit_ can look for configuration in the following two locations:
- In a `ckit.yaml` file in the current directory
- In any `.yaml` file in the the global configuration directory, which is defaulted to `~/ckit`, but which can be overridden with the environment variable `CKIT_HOME`.
An example `.yaml` file could look as follows:
```yaml
test:
my-command:
cmd: "echo Hello! My name is: $name. My favourite fruit is: $fruit"
echo: false
args:
- name
- fruit: apple
```
Which adds the command group `test` wth a single command called `my-command`. When `my-command` is selected to be run, _ckit_ prompts the user for `name` and `fruit` before running the command specified in `cmd`, where `fruit` is defaulted to `apple` if the user does not give any input.
For more details, see the [configuration](https://fpgmaas.github.io/ckit/configuration) section of the documentation.
---
Repository initiated with [fpgmaas/cookiecutter-poetry](https://github.com/fpgmaas/cookiecutter-poetry).