{"id":15656804,"url":"https://github.com/limebrains/sufler","last_synced_at":"2025-05-05T15:26:07.929Z","repository":{"id":53534666,"uuid":"124051071","full_name":"limebrains/sufler","owner":"limebrains","description":"generating bash/zsh/powershell/fish autocompletions from yml file","archived":false,"fork":false,"pushed_at":"2021-03-25T21:56:10.000Z","size":70,"stargazers_count":4,"open_issues_count":1,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-25T13:40:37.855Z","etag":null,"topics":["autocomplete","bash","fish","powershell","python","yaml","zsh"],"latest_commit_sha":null,"homepage":"","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/limebrains.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-03-06T09:06:19.000Z","updated_at":"2023-12-01T07:50:34.000Z","dependencies_parsed_at":"2022-08-20T13:01:05.433Z","dependency_job_id":null,"html_url":"https://github.com/limebrains/sufler","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/limebrains%2Fsufler","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/limebrains%2Fsufler/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/limebrains%2Fsufler/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/limebrains%2Fsufler/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/limebrains","download_url":"https://codeload.github.com/limebrains/sufler/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242741033,"owners_count":20177753,"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":["autocomplete","bash","fish","powershell","python","yaml","zsh"],"created_at":"2024-10-03T13:04:25.882Z","updated_at":"2025-03-09T19:31:32.746Z","avatar_url":"https://github.com/limebrains.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Sufler\n \nSufler - is the tool to help you with generating bash/zsh/powershell/fish autocompletions from YAML file. \n\n[![Build Status](https://travis-ci.org/limebrains/sufler.svg?branch=master)](https://travis-ci.org/limebrains/sufler)\n[![coveralls](https://coveralls.io/repos/limebrains/sufler/badge.svg?branch=master\u0026service=github)](https://coveralls.io/github/limebrains/sufler?branch=master)\n[![Documentation Status](https://readthedocs.org/projects/sufler/badge/?version=latest)](http://sufler.readthedocs.io/en/latest/?badge=latest)\n\n[Documentation](http://sufler.readthedocs.io/en/latest/?badge=latest)\n \n## Usage\n\n[![gif](https://i.imgur.com/u09q5be.gif)](http://sufler.readthedocs.io)\n\n```bash\n| =\u003e sufler --help\nUsage: sufler [OPTIONS] COMMAND [ARGS]...\n\nOptions:\n  --help  Show this message and exit.\n\nCommands:\n  init     initialize Sufler directory and config file\n  install  install completions\n  run      run command from \u003cRun \u003e\n\n```\n \n## Quickstart:\n\n```bash\npip install sufler\n```\n\nor \n\n```\nbash -c \"$(curl -fsSL https://raw.githubusercontent.com/limebrains/sufler/master/install.bash)\"\n```\n\nyou will have directory in your home dir where you can install your custom completions.\n```\n/Users/pythonicninja/.sufler/\n├── completions\n│   ├── npm.yml\n│   └── pip.yml\n└── .config\n```\n\nthere is repo which accepts PR's with common completions \n[sufler-completions - github.com](https://github.com/limebrains/sufler-completions)\n\n## Key ideas:\n\n### Example yml file:\n```yaml\n'pip': \u0026pip\n    'install': \u0026install\n        '--constrain': \u0026constraint\n            '\u003cFile\u003e': *install\n        '--build': \u0026build\n            '\u003cFile\u003e': *install\n        '--no-deps': *install\n        '--install-option':\n          '\u003cExec\u003e wget https://pypi.python.org/simple/ -O ~/.sufler/python_completions -c -q \u0026\u0026 cat ~/.sufler/python_completions | cut -d \"\u003e\" -f 2 | cut -d \"\u003c\" -f 1 | grep \"^TREE~1.*\"': *install\n```\n[full raw file](https://raw.githubusercontent.com/limebrains/sufler-completions/master/completions/pip.yml)\n\nPlease notice special names of keys such as:\n\n- `\u003cExec\u003e`\n\n- `\u003cFile\u003e`\n\n- `\u003cRegex\u003e`\n\n- `\u003cRun\u003e`\n\n[All of them are documented in details - readthedocs.io](http://sufler.readthedocs.io/en/latest/user/advanced.html)\n\n### Origin of the name\nName comes from (pol. sufler - [wiki](https://pl.wikipedia.org/wiki/Sufler))  \n\u003e The prompter (sometimes prompt) in a theatre is a person who prompts or cues actors when they forget their lines or neglect to move on the stage to where they are supposed to be situated. \n \n![sufler](https://i.imgur.com/MWrtIhi.jpg)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flimebrains%2Fsufler","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flimebrains%2Fsufler","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flimebrains%2Fsufler/lists"}