{"id":13593037,"url":"https://github.com/DiaAzul/Posh-Predictive-Text","last_synced_at":"2025-04-09T02:32:12.075Z","repository":{"id":60927015,"uuid":"519552783","full_name":"DiaAzul/Posh-Predictive-Text","owner":"DiaAzul","description":"PowerShell predictive text for popular command line tools.","archived":false,"fork":false,"pushed_at":"2023-12-11T11:13:52.000Z","size":1500,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-11-06T14:41:35.928Z","etag":null,"topics":["command-line-tool","csharp","powershell","powershell-module","productivity-tool","tab-expansion","tab-expansion-handlers"],"latest_commit_sha":null,"homepage":"https://posh-predictive-text.readthedocs.io","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DiaAzul.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.txt","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},"funding":{"github":"DiaAzul","patreon":null,"open_collective":null,"ko_fi":"davidplummer","tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":null}},"created_at":"2022-07-30T15:28:59.000Z","updated_at":"2024-01-03T14:13:14.000Z","dependencies_parsed_at":"2024-11-06T14:38:01.895Z","dependency_job_id":"ac98efa2-1e1e-49a4-9310-069aa1f29fd5","html_url":"https://github.com/DiaAzul/Posh-Predictive-Text","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DiaAzul%2FPosh-Predictive-Text","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DiaAzul%2FPosh-Predictive-Text/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DiaAzul%2FPosh-Predictive-Text/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DiaAzul%2FPosh-Predictive-Text/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DiaAzul","download_url":"https://codeload.github.com/DiaAzul/Posh-Predictive-Text/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247965644,"owners_count":21025411,"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":["command-line-tool","csharp","powershell","powershell-module","productivity-tool","tab-expansion","tab-expansion-handlers"],"created_at":"2024-08-01T16:01:15.888Z","updated_at":"2025-04-09T02:32:11.040Z","avatar_url":"https://github.com/DiaAzul.png","language":"C#","funding_links":["https://github.com/sponsors/DiaAzul","https://ko-fi.com/davidplummer","https://ko-fi.com/R5R0EC7N8"],"categories":["C#","C\\#"],"sub_categories":[],"readme":"[![Build status](https://ci.appveyor.com/api/projects/status/ei77wk9mkauty0j2/branch/main?svg=true)](https://ci.appveyor.com/project/DiaAzul/posh-predictive-text/branch/main)\n[![Documentation Status](https://readthedocs.org/projects/posh-predictive-text/badge/?version=latest)](https://posh-predictive-text.readthedocs.io/en/latest/?badge=latest)\n\n# Posh Predictive Text\n\n\u003cimg src=\"./Assets/PoshPredictiveTextPlain.png\"\n     alt=\"Powershell predictive text logo\"\n     width=128\n     align=\"right\"/\u003e\n\n\u003e PowerShell module providing predictive text completions for common CLI tools.\n\nMost people will be familiar with predictive text on mobile phones.\nPosh-predictive-text brings the same capability to the PowerShell command line\ninterface for common CLI tools used within the software development and data\nscience community.\n\nModern command line tools are highly configurable and have many parameters. It\nis difficult to remember them all. Posh Predictive Text improves productivity,\nnot only by providing suggested completions, but also providing a pop-up list\nof suggestions with tooltips. These tooltips remove the need to break off from\nenter the command and search documentation for the correct parameter name.\n\nIn addition, Posh Predictive Text is also able to suggest a limited number of\nparameter arguments. For instance when using conda to activate an environment\na list of environments is shown.\n\nPoshPredictiveText provides suggested completions in the following situations:\n\n- When a partial argument is entered and the `tab` key is pressed. Successive suggestion \nappear each time the `tab` key is pressed.\n- Pressing `ctrl` + `space` displays a popup list of options with tooltips.\n- If PSReadLine options `-PredictionSource` is set to use the plugin and `-PredictionViewStyle`\nis set to `ListView` then suggestions will appear below the command line.\n\n\u003chttps://user-images.githubusercontent.com/28156158/190742185-8842a5cf-3cc5-4945-8571-66d9ad6b4e6e.mp4\u003e\n\n## Supported Command Line Tools\n\nPredictive text is available for the following commands line tools.\n\n- conda\n\nIf a tools is not supported then please consider helping by developing the syntax tree file\nneeded to support it. Further information is available in the developer documentation.\n\n## Sponsorship\n\nWe all love open-source software. It's the freedom to use it and adapt it as you like. Its the no\ncost option. However, without funding open-source projects die. If you find this software useful\nthen consider sponsoring the developers. It doesn't have to be a lot. The cost of a cup of coffee\nwill do. Little contributions help and it is all very much appreciated.\n\nGitHub Sponsors:\n\nPlease use the button at the top of the page to contribute via GitHub sponsors.\n\nKo-fi:\n\n[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/R5R0EC7N8)\n\n## Installing / Getting started\n\nPoshPredictiveText requires PowerShell version `7.2` or greater, and PSReadLine version `2.6` or\ngreater.\n\nYou can check the version of PowerShell using the following command.\n\n```powershell\n$PSVersionTable.PSVersion\n```\n\nThe latest version of PowerShell is available on [Github](https://github.com/PowerShell/PowerShell).\n\nYou can check the version of PSReadLine using the following command.\n\n```powershell\nGet-Module PSReadLine | Format-List\n```\n\nVersion `2.2.6` is pre-release and to install it the `AllowPreRelease` and `-force` options are required.\n\n```powershell\nInstall-Module PSReadLine -AllowPrerelease -Force\n```\n\nInstall PoshPredictiveText from the [PowerShell Gallery](https://www.powershellgallery.com/packages/PoshPredictiveText).\nThis will download the module to the local user account. You may be asked for permission\nif you have not already set PowerShell gallery as trusted source.\n\n```shell\nInstall-Module -name PoshPredictiveText\n```\n\nAdd the following commands to the PowerShell profile. To locate the PowerShell profile open\na command prompt and type `$PROFILE`.\n\n```powershell\nSet-PredictiveTextOption -RemoveCondaTabExpansion\nInstall-PredictiveText\n```\n\nThe first command removes tab-expansion that is already installed by conda, and which prevents\nPosh Predictive Text from providing completions. The second command installs Posh Predictive\nText.\n\nCompletions will appear when a partial argument is entered and the tab key is pressed. A longer\nlist of options with tooltips is available by pressing ctrl-space.\n\nIt is recommended to add the following PSReadLine options in the PowerShell profile so that\nsuggestions appear below the command line as command arguments are entered.\n\n```powershell\nSet-PSReadLineOption -PredictionSource HistoryAndPlugin -PredictionViewStyle ListView\n```\n\n## Contributing\n\nContributions to the project are welcome. No developer is an island, there is never enough time\nto do everything and there is always another way to do things which may be better.\n\nIf you have a problem then raise an issue on the project issue tracker. If you have a suggested\ncode improvement then submit a pull request.\n\nIf you wish to add support for another command line tool then read the [developer documentation\non the project web site](https://posh-predictive-text.readthedocs.io/en/latest/pages/development.html).\nThis will explain how the syntax tree files are developed, processed and integrated into the tool.\n\n## Links\n\n- Project homepage: \u003chttps://posh-predictive-text.readthedocs.io\u003e\n- Repository: \u003chttps://github.com/DiaAzul/Posh-Predictive-Text\u003e\n- PowerShell Gallery: \u003chttps://www.powershellgallery.com/packages/PoshPredictiveText\u003e\n- Issue tracker: \u003chttps://github.com/DiaAzul/Posh-Predictive-Text/issues\u003e\n  - In case of sensitive bugs like security vulnerabilities, please contact\n    me using the `contact owners` form listed under info on the PowerShell Gallery page\n    for the module \u003chttps://www.powershellgallery.com/packages/PoshPredictiveText\u003e.\n\n## Licensing\n\nThe code in this project is licensed under the Apache-2.0 license.\n\nThe name Posh Predictive Text and associated trade marks are the property of Tanzo Creative Ltd.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FDiaAzul%2FPosh-Predictive-Text","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FDiaAzul%2FPosh-Predictive-Text","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FDiaAzul%2FPosh-Predictive-Text/lists"}