{"id":17383297,"url":"https://github.com/yamaton/vscode-h2o","last_synced_at":"2025-07-13T01:36:08.609Z","repository":{"id":42031071,"uuid":"372039388","full_name":"yamaton/vscode-h2o","owner":"yamaton","description":"Add CLI autocomplete functionalities to Shell Script","archived":false,"fork":false,"pushed_at":"2023-11-05T23:27:19.000Z","size":52633,"stargazers_count":20,"open_issues_count":3,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-28T18:51:58.641Z","etag":null,"topics":["bash","bioinformatics","cli","intellisense","shellscript","vscode-extension"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/yamaton.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2021-05-29T18:01:07.000Z","updated_at":"2025-03-20T04:04:13.000Z","dependencies_parsed_at":"2023-10-12T13:01:03.340Z","dependency_job_id":"7b215778-7cd1-406b-8896-5697832e6933","html_url":"https://github.com/yamaton/vscode-h2o","commit_stats":null,"previous_names":[],"tags_count":35,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yamaton%2Fvscode-h2o","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yamaton%2Fvscode-h2o/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yamaton%2Fvscode-h2o/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yamaton%2Fvscode-h2o/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yamaton","download_url":"https://codeload.github.com/yamaton/vscode-h2o/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249045378,"owners_count":21203865,"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":["bash","bioinformatics","cli","intellisense","shellscript","vscode-extension"],"created_at":"2024-10-16T07:41:11.628Z","updated_at":"2025-04-15T09:40:37.388Z","avatar_url":"https://github.com/yamaton.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Shell Script Command Completion\n\nThis extension brings autocompletion and introspection of shell commands to VS Code, enhancing the **Shell Script mode**.\n\n## Features\n\n* Autocomplete command-line options, flags, and subcommands\n* Hover to get descriptions for subcommands and options/flags\n* **Zero configuration** required\n* 🧬 Opt-in support for bioinformatics CLI tools 🧬\n\n## Demos\n\n### Autocomplete in Shell Script\n\n![shellcomp](https://raw.githubusercontent.com/yamaton/vscode-h2o/main/images/demo-autocomplete.gif)\n\n### Introspection with Hover\n\n![hover](https://raw.githubusercontent.com/yamaton/vscode-h2o/main/images/demo-mouseover.gif)\n\n## Supported Commands\n\nThe extension comes preloaded with 400+ CLI specifications but can also dynamically create specs by scanning man pages or `--help` documents. The preloaded specs include common tools like `git`, `npm`, `docker`, `terraform`, and many more. See the complete list in [general.txt](https://github.com/yamaton/h2o-curated-data/blob/main/general.txt). If you'd like more tools to be added, please [submit a request here](https://github.com/yamaton/h2o-curated-data/issues/1).\n\n### 🧬 Extra Command Specs for Bioinformatics\n\nOver 500 command specifications for bioinformatics tools can be optionally loaded. In \"Shell Script\" mode, press `Ctrl`+`Shift`+`P` (or `⌘`+`⇧`+`P` on macOS) and select `Shell Completion: Load Bioinformatics CLI Specs`. If the commands are not recognized, you may need to clear the cache as described below. The supported tools include `BLAST`, `GATK`, `seqkit`, `samtools`, and more. View [bio.txt](https://github.com/yamaton/h2o-curated-data/blob/main/bio.txt) for the full list and [submit any requests for additional tools here](https://github.com/yamaton/h2o-curated-data/issues/1).\n\n## Managing Command Specs\n\nThe \"Shell Commands\" Explorer in the Side Bar displays loaded command specifications.\n\n![](https://raw.githubusercontent.com/yamaton/vscode-h2o/main/images/vscode-shell-command-explorer.png)\n\n## 🔥 Troubleshooting\n\n### 😞 Not Working?\n\n* If the command is on [this list](https://github.com/yamaton/h2o-curated-data/blob/main/general.txt), activate \"Shell Script\" mode, then type `Ctrl`+`Shift`+`P` (or `⌘`+`⇧`+`P` on macOS) and choose `Shell Completion: Load Common CLI Specs` to reload the common CLI specs.\n* If the command is in [this bio list](https://github.com/yamaton/h2o-curated-data/blob/main/bio.txt), activate \"Shell Script\" mode, then type `Ctrl`+`Shift`+`P` (or `⌘`+`⇧`+`P` on macOS) and choose `Shell Completion: Load Bioinformatics CLI Specs` to reload the bioinformatics CLI specs.\n* If the command is still not recognized, activate \"Shell Script\" mode, then type `Ctrl`+`Shift`+`P` (or `⌘`+`⇧`+`P` on macOS) and choose `Shell Completion: Remove Command Spec`, then enter the name of the command to remove it from the cache. Our program will then try to recreate the CLI spec.\n\n### 😞 Annoyed by Aggressive Suggestions?\n\nAdjust suggestions with the VS Code settings:\n* Suppress **Quick Suggestions**\n* Deactivate SPACE-key triggering with **Suggest on Trigger Characters**\n\nNote: These settings apply to other language modes as well.\n\n### 😞 Annoyed by Unwanted Commands?\n\nUse the Shell Commands Explorer to remove unnecessary command specs. To remove all bioinformatics commands, activate \"Shell Script\" mode, type `Ctrl`+`Shift`+`P` (or `⌘`+`⇧`+`P` on macOS), and choose `Shell Completion: Remove Bioinformatics CLI Specs`.\n\n## 🔧 How the Extension Works\n\n* Utilizes [preprocessed specs](https://github.com/yamaton/h2o-curated-data/tree/main/general/json) when available.\n* Extracts CLI information by parsing `man \u003ccommand\u003e` or `\u003ccommand\u003e --help`.\n* Runs on Linux/WSL and macOS only.\n* Depends on [tree-sitter](https://tree-sitter.github.io/tree-sitter/) to understand the shell script structure.\n\n## 🛡️ Security with Sandboxing\n\nThe extension executes unrecognized commands with `--help` to gather information, potentially posing a risk if untrusted programs are present locally. To mitigate this risk, it uses a sandbox environment if available, ensuring that unrecognized commands run in a controlled and secure environment, limiting network and filesystem access.\n\n* macOS: Always runs in a sandbox with `sandbox-exec`.\n* **Linux or WSL**: Consider installing **[bubblewrap](https://wiki.archlinux.org/title/Bubblewrap)**.\n\n## ⚠️ Known Issues\n\n* Autocomplete and hover introspection require either:\n  * The command in [preprocessed CLI specs](https://github.com/yamaton/h2o-curated-data/tree/main/general/json) to be loaded at startup.\n  * Successful extraction of CLI information by the included parser from the local environment.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyamaton%2Fvscode-h2o","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyamaton%2Fvscode-h2o","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyamaton%2Fvscode-h2o/lists"}