{"id":13500305,"url":"https://github.com/cooklang/CookCLI","last_synced_at":"2025-03-29T05:33:29.868Z","repository":{"id":38347486,"uuid":"330776661","full_name":"cooklang/cookcli","owner":"cooklang","description":"Command line program which provides a suite of tools to create shopping lists and maintain recipes.","archived":false,"fork":false,"pushed_at":"2025-03-16T21:29:13.000Z","size":16311,"stargazers_count":827,"open_issues_count":28,"forks_count":42,"subscribers_count":12,"default_branch":"main","last_synced_at":"2025-03-28T19:37:57.140Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://cooklang.org","language":"Rust","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/cooklang.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","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":"2021-01-18T20:15:52.000Z","updated_at":"2025-03-27T16:07:50.000Z","dependencies_parsed_at":"2024-01-16T09:54:28.674Z","dependency_job_id":"c34c6a80-9d03-4d6c-8bcf-e9a418d7f2cb","html_url":"https://github.com/cooklang/cookcli","commit_stats":null,"previous_names":[],"tags_count":28,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cooklang%2Fcookcli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cooklang%2Fcookcli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cooklang%2Fcookcli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cooklang%2Fcookcli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cooklang","download_url":"https://codeload.github.com/cooklang/cookcli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246145013,"owners_count":20730494,"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":[],"created_at":"2024-07-31T22:00:55.339Z","updated_at":"2025-03-29T05:33:29.826Z","avatar_url":"https://github.com/cooklang.png","language":"Rust","funding_links":[],"categories":["Productivity","Swift","Applications","Utility","Projects"],"sub_categories":["Testing","Productivity","Video Converters and Compressors"],"readme":"# CookCLI\n\nCookCLI provides a suite of tools to create shopping lists and maintain recipes. We've built it to be simple and useful for automating your cooking and shopping routine with existing UNIX command line and scripting tools. It can also function as a webserver for your recipes, making them browsable on any device with a web browser.\n\n* [Example usage](#example-usage)  \n* [Installation](#installation)  \n* [Building from source](#building-from-source)  \n* [Contribution](#contribution)  \n* [License](#license)  \n\n## Example usage\n\nAdd sample recipes:\n\n```\n$ cook seed\n$ tree .\n.\n├── Baked Potato Soup.cook\n...\n├── Neapolitan Pizza.cook\n...\n├── README.md\n├── Root Vegetable Tray Bake.cook\n...\n└── config\n    └── aisle.conf\n\n3 directories, 15 files\n```\n\nCheck \"Neapolitan Pizza\":\n```\n$ cook recipe read \"Neapolitan Pizza.cook\"\nMetadata:\n    servings: 6\n\nIngredients:\n    chopped tomato                3 cans\n    dried oregano                 3 tbsp\n    fresh basil                   18 leaves\n    fresh yeast                   1.6 g\n    garlic                        3 gloves\n    mozzarella                    3 packs\n    parma ham                     3 packs\n    salt                          25 g\n    tipo zero flour               820 g\n    water                         530 ml\n\nSteps:\n     1. Make 6 pizza balls using tipo zero flour, water, salt and fresh yeast. Put in a fridge for 2 days.\n        [fresh yeast: 1.6 g; salt: 25 g; tipo zero flour: 820 g; water: 530 ml]\n     2. Set oven to max temperature and heat pizza stone for about 40 minutes.\n        [–]\n     3. Make some tomato sauce with chopped tomato and garlic and dried oregano. Put on a pan and leave for 15 minutes occasionally stirring.\n        [chopped tomato: 3 cans; dried oregano: 3 tbsp; garlic: 3 gloves]\n     4. Make pizzas putting some tomato sauce with spoon on top of flattened dough. Add fresh basil, parma ham and mozzarella.\n        [fresh basil: 18 leaves; mozzarella: 3 packs; parma ham: 3 packs]\n     5. Put in an oven for 4 minutes.\n        [–]\n\n```\n\nCreate a shopping list:\n```\n$ cook shopping-list \\\n\u003e Neapolitan\\ Pizza.cook \\\n\u003e Root\\ Vegetable\\ Tray\\ Bake.cook\nBREADS AND BAKED GOODS\n    breadcrumbs                   150 g\n\nDRIED HERBS AND SPICES\n    dried oregano                 3 tbsp\n    dried sage                    1 tsp\n    pepper                        1 pinch\n    salt                          25 g, 2 pinches\n\nFRUIT AND VEG\n    beetroots                     300 g\n    carrots                       300 g\n    celeriac                      300 g\n    fresh basil                   18 leaves\n    garlic                        3 gloves\n    lemon                         1 item\n    onion                         1 large\n    red onion                     2 items\n    thyme                         2 springs\n\nMEAT AND SEAFOOD\n    parma ham                     3 packs\n\nMILK AND DAIRY\n    butter                        15 g\n    egg                           1 item\n    mozzarella                    3 packs\n\nOILS AND DRESSINGS\n    Dijon mustard                 1 tsp\n    Marmite                       1 tsp\n    cider                         150 ml\n    olive oil                     3 tbsp\n\nOTHER (add new items into aisle.conf)\n    tipo zero flour               820 g\n\nPACKAGED GOODS, PASTA AND SAUCES\n    vegetable stock               150 ml\n    water                         530 ml\n\nTINNED GOODS AND BAKING\n    cannellini beans              400 g\n    chopped tomato                3 cans\n    fresh yeast                   1.6 g\n    redcurrant jelly              1 tsp\n```\n\nRun a web-server:\n\n    $ cook server\n    Started server on http://127.0.0.1:9080, serving cook files from /Users/pochho/recipes.\n\n![server](https://user-images.githubusercontent.com/4168619/148116974-7010e265-5aa8-4990-a4b9-f85abe3eafb0.png)\n\n\nYou can find full documentation at https://cooklang.org/cli/help/ or by running `help` command.\n\n```\nUsage: cook [OPTIONS] COMMAND\n\nOptions:\n    -a, --aisle \u003caisle\u003e             Specify an aisle.conf file to override shopping list default settings \n    -u, --units \u003cunits\u003e             Specify a units.conf file to override units default settings\n    -i, --inflection \u003cinflection\u003e   Specify an inflection.conf file to override default inflection settings\n    -h, --help                      Show help information.\n\nCommands:\n    recipe                  Manage recipes and recipe files\n    shopping-list           Create a shopping list\n    server                  Run a webserver to serve your recipes on the web\n    fetch                   Pull recipes from the community recipe repository\n    version                 Show the CookCLI version information\n    help                    Show the help text for a sub-command\n```\n\n## Installation\n\nDownload latest release for your platform from the [releases page](https://github.com/cooklang/CookCLI/releases) and add the file to your operating system's PATH.\n\nOn Linux (or [WSL](https://docs.microsoft.com/en-us/windows/wsl/about)), this is easy. Simply extract the binary into your binaries folder with `sudo unzip CookCLI_1.0.0_linux_amd64.zip -d /usr/local/bin/` (note: you may need to install the unzip package first). \n\nOn MacOS:\n\n    brew tap cooklang/tap\n    brew install cooklang/tap/cook\n\n\n## Building from source\n\n1. Checkout code.\n2. Install Rust by following official [instructions](https://www.rust-lang.org/tools/install).\n3. Install Node.js by following official [instructions](https://nodejs.org/en/learn/getting-started/how-to-install-nodejs).\n4. Build UI server\n\n```\ncd ui \u0026\u0026 npm install \u0026\u0026 npm run build\n```\n5. Build CookCLI from a directory with the source code:\n\n```\ncargo build --release\n```\n4. Take binary from `target/release/cook`.\n\n## Contribution\n\nPlease open issues for any ideas you may have to contribute to the project. See [Contribution guidelines](CONTRIBUTING.md) for details.\n\n## License\n\nMIT License\n\nCopyright (c) 2021-2023 Alexey Dubovskoy\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\nSome source files include a substantial portion of code from\nhttps://github.com/Zheoni/cooklang-chef.\n\nThe original code is licensed under the MIT License, a copy of which\nis provided in these files in addition to our project's license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcooklang%2FCookCLI","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcooklang%2FCookCLI","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcooklang%2FCookCLI/lists"}