waveterm/inshellisense
0
0
Fork 0
mirror of https://github.com/wavetermdev/inshellisense.git synced 2026-08-05 13:43:30 -07:00
Code Issues Packages Projects Releases Wiki Activity

docs: update readme

Browse Source
This commit is contained in:
Chapman Pendery
2023-12-14 15:02:12 -08:00
committed by GitHub
parent eb8e9e5259
commit 785ca0f748
1 changed files with 19 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+19
View File
@@ -21,6 +21,25 @@ npm install -g @microsoft/inshellisense
After completing the installation, you can run `is` to start the autocomplete session for your desired shell. Additionally, inshellisense is also aliased under `inshellisense` after installation.
### Usage
| Action | Command |
| ------------------------------------- | ------- |
| Start | `is` |
| Stop | `exit` |
| Check If Inside Inshellisense Session | `is -c` |
#### Keybindings
All other keys are passed through to the shell. The keybindings below are only captured when the inshellisense suggestions are visible, otherwise they are passed through to the shell as well.
| Action | Keybinding |
| ------------------------- | -------------- |
| Accept Current Suggestion | <kbd>tab</kbd> |
| View Next Suggestion | <kbd>↓</kbd> |
| View Previous Suggestion | <kbd>↑</kbd> |
| Dismiss Suggestions | <kbd>esc</kbd> |
## Integrations
inshellisense supports the following shells: