{"id":18037455,"url":"https://github.com/fpgmaas/ckit","last_synced_at":"2025-07-22T10:39:11.095Z","repository":{"id":103226803,"uuid":"580426806","full_name":"fpgmaas/ckit","owner":"fpgmaas","description":"A command line utility to help you organise and quickly run frequently used commands.","archived":false,"fork":false,"pushed_at":"2023-03-27T10:19:20.000Z","size":1753,"stargazers_count":65,"open_issues_count":4,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-07-11T22:06:19.096Z","etag":null,"topics":["bash","cli","command-line","commands","python","shell"],"latest_commit_sha":null,"homepage":"https://fpgmaas.github.io/ckit","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fpgmaas.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.rst","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-12-20T14:33:36.000Z","updated_at":"2025-06-05T21:24:15.000Z","dependencies_parsed_at":"2023-07-11T07:46:41.026Z","dependency_job_id":null,"html_url":"https://github.com/fpgmaas/ckit","commit_stats":{"total_commits":35,"total_committers":1,"mean_commits":35.0,"dds":0.0,"last_synced_commit":"2d44c02de59e37a0ec58f900dd913c7ca8edb33e"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/fpgmaas/ckit","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fpgmaas%2Fckit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fpgmaas%2Fckit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fpgmaas%2Fckit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fpgmaas%2Fckit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fpgmaas","download_url":"https://codeload.github.com/fpgmaas/ckit/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fpgmaas%2Fckit/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266477586,"owners_count":23935476,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-22T02:00:09.085Z","response_time":66,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bash","cli","command-line","commands","python","shell"],"created_at":"2024-10-30T13:10:29.058Z","updated_at":"2025-07-22T10:39:11.047Z","avatar_url":"https://github.com/fpgmaas.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"ckit logo\" width=\"460\" height=\"300\" src=\"https://raw.githubusercontent.com/fpgmaas/ckit/main/docs/static/ckit-logo.svg\"\u003e\n\u003c/p\u003e\n\n---\n\n[![Release](https://img.shields.io/github/v/release/fpgmaas/ckit)](https://img.shields.io/github/v/release/fpgmaas/ckit)\n[![Build status](https://img.shields.io/github/actions/workflow/status/fpgmaas/ckit/main.yml?branch=main)](https://github.com/fpgmaas/ckit/actions/workflows/main.yml?query=branch%3Amain)\n[![Supported Python versions](https://img.shields.io/pypi/pyversions/ckit)](https://pypi.org/project/ckit/)\n[![codecov](https://codecov.io/gh/fpgmaas/ckit/branch/main/graph/badge.svg)](https://codecov.io/gh/fpgmaas/ckit)\n[![PyPI - Downloads](https://img.shields.io/pypi/dm/ckit)](https://pypistats.org/packages/ckit)\n[![License](https://img.shields.io/github/license/fpgmaas/ckit)](https://img.shields.io/github/license/fpgmaas/ckit)\n\n_ckit_ is a command line utility to help you organise and quickly run frequently used commands.\n\n\u003cp align=\"center\"\u003e\n\u003cimg src=\"docs/static/ckit.gif\"/\u003e\n\u003c/p\u003e\n\n---\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://fpgmaas.github.io/ckit\"\u003eDocumentation\u003c/a\u003e - \u003ca href=\"https://github.com/fpgmaas/ckit-files/\"\u003eExample configuration files\u003c/a\u003e\n\u003c/p\u003e\n\n---\n\n## Quickstart\n\n### Installation\n\n_ckit_ can be installed by running\n\n```shell\npip install ckit\n```\n\nTo get started, run\n\n```bash\nckit init\n```\n\nwhich 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\n\n```bash\nckit init --download-global-defaults\n```\n\nto get started with a richer set of examples in the global configuration directory, see [ckit-files](https://github.com/fpgmaas/ckit-files/).\n\nTo use _ckit_ to run any of the pre-configured commands, simply run\n\n```\nckit\n```\n\n## Configuration\n\n_ckit_ can look for configuration in the following two locations:\n\n- In a `ckit.yaml` file in the current directory\n- 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`.\n\nAn example `.yaml` file could look as follows:\n\n```yaml\ntest:\n  my-command:\n    cmd: \"echo Hello! My name is: $name. My favourite fruit is: $fruit\"\n    echo: false\n    args:\n      - name\n      - fruit: apple\n```\n\nWhich 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.\n\nFor more details, see the [configuration](https://fpgmaas.github.io/ckit/configuration) section of the documentation.\n\n---\n\nRepository initiated with [fpgmaas/cookiecutter-poetry](https://github.com/fpgmaas/cookiecutter-poetry).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffpgmaas%2Fckit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffpgmaas%2Fckit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffpgmaas%2Fckit/lists"}