{"id":19154247,"url":"https://github.com/dotdot0/runner","last_synced_at":"2025-05-07T06:28:29.403Z","repository":{"id":63194987,"uuid":"565208985","full_name":"dotdot0/runner","owner":"dotdot0","description":"A cli tool that let's you map commands to a shorter alias","archived":false,"fork":false,"pushed_at":"2023-04-15T22:32:08.000Z","size":2380,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-19T19:05:37.472Z","etag":null,"topics":["cli","productivity","rust"],"latest_commit_sha":null,"homepage":"https://crates.io/crates/runner-cli","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dotdot0.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2022-11-12T17:15:46.000Z","updated_at":"2023-03-17T11:20:16.000Z","dependencies_parsed_at":"2023-07-14T09:15:17.346Z","dependency_job_id":null,"html_url":"https://github.com/dotdot0/runner","commit_stats":null,"previous_names":["pratushrai/runner","pratushrai0309/runner","sudoerp/runner","dotdot0/runner"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dotdot0%2Frunner","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dotdot0%2Frunner/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dotdot0%2Frunner/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dotdot0%2Frunner/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dotdot0","download_url":"https://codeload.github.com/dotdot0/runner/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252826302,"owners_count":21810093,"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","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":["cli","productivity","rust"],"created_at":"2024-11-09T08:26:01.313Z","updated_at":"2025-05-07T06:28:29.386Z","avatar_url":"https://github.com/dotdot0.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Runner\n\n## 🤔 What is this?\nA cli tool that let's you map commands to a shorter alias. Run the mapped command using the \u003cALIAS_NAME\u003e.\n\n```\nrunner \u003cALIAS_NAME\u003e\n```\nYou can map all your commands in runner.toml file\n\nAn example runner.toml file:\n```toml\n[Command]\nalias = \"ci\"\nprogram = \"cargo\"\nargs = [\"install\", \"lsd\"]\n\n[Command]\nalias = \"nv\"\nprogram = \"node\"\nargs = [\"-v\"]\n\n[Command]\nalias = \"cc\"\nprogram = \"cargo\"\nargs = [\"check\"]\n\n```\n### An example run for [ci] alias\n### Output: \n\u003cimg src = \"images/ci.gif\"\u003e\n\n## 📦 Installation\n```\ncargo install runner-cli\n```\n\n## 🏁 Initialize\n\n#### It will initialize a empty runner.toml file in config directory\n\n```\nrunner --init\n```\n### Output:\n\u003cimg src = \"images/init.gif\"\u003e\n\n\n## ⚙️ Config\n\n#### Get the path to runner.toml file by running runner with config option\n```\nrunner --config\n```\n\n## 🗺️ Mappings\n\n#### Get all the user mapped alias\n\n```\nrunner --mapping\n```\n\n### Output: \n\n\u003cimg src = \"images/mapping.png\"\u003e\n\n## ➕ Add\n\n#### Map a new command to an alias right from the terminal\n\n```\nrunner --add\n```\n\n### Output: \n\n\u003cimg src = \"images/add.gif\"\u003e)\n\n## 🔍 Find\n\n#### Find a command mapped to the given alias\n\n```\nrunner --find \u003cALIAS_NAME\u003e\n```\n\n### Output:\n\n\u003cimg src = \"images/find.gif\"\u003e\n\n## Available \n#### Check if a alias is available to use\n\n```\nrunner --available \u003cALIAS_NAME\u003e\n```\n\n## 🖥️ Options:\n\n```\n    -a, --add        Map a new command to a alias right from terminal\n        --available  Check if a alias is available to use\n    -c, --config     Path of the the config file runner.toml\n    -f, --find       Find a command mapped to the give alias\n    -h, --help       Print help information\n    -i, --init       Initialize a empty runner.toml file\n    -m, --mapping    Show all the user defined mappings\n    -V, --version    Print version information\n```\n\n## 📄 TOML file guide:\n\n#### Each command starts wtih a [Command] key\n\n\n```toml\n[Command]\nalias =  \"Shorter subcommand you want to use instead of the command\"\nprogram = \"CLI Program Name(like: git, cat, batcat, code, neofetch, cargo, python, node, npm etc.)\"\nargs = \"Arguments you want to pass to the cli program\"\n```\n\n## Contribution\n#### Have any suggestion or feature idea/request feel free to open a issue.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdotdot0%2Frunner","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdotdot0%2Frunner","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdotdot0%2Frunner/lists"}