README.md

---

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

pip install ckit

To get started, run

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

ckit init --download-global-defaults

to get started with a richer set of examples in the global configuration directory, see 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:

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 section of the documentation.

---

Repository initiated with fpgmaas/cookiecutter-poetry.