Skip to content

Commit 2f648d6

Browse files
committed
Update readme to include info on integration with other plugins
1 parent e50b5e0 commit 2f648d6

File tree

1 file changed

+24
-2
lines changed

1 file changed

+24
-2
lines changed

README.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,14 @@ The plugin uses a pseudo-terminal to start the underlying shell which means it s
1313
* Terminal shortcuts (`ctrl`+`c`, etc.)
1414
* Basically everything you would expect from a terminal
1515

16-
Besides this it also supports
16+
In addition it also supports
1717

1818
* Integration with the Sublime Text build system
1919
* Shell colors (8 color support for now - development for 256 is planned)
2020
* Scrollback history
2121
* Copy/Pasting
2222
* Static syntax highlighting (as an addition to shell colors)
23+
* Integration with other plugins
2324

2425
**Note, if you encounter any issues please check the "Common problems" section at the bottom for a solution.**
2526

@@ -118,7 +119,7 @@ If you really want to avoid using bash you can also run your shell directly:
118119
{ "keys": ["ctrl+alt+t"], "command": "terminal_view_open", "args": {"cmd": "/usr/bin/ipython", "title": "Terminal (IPython)"}},
119120
```
120121

121-
but this is **very experimental**. Some future development regarding this is planned, but at the moment only bash is tested.
122+
but this is **experimental**. Some future development regarding this is planned, but at the moment only bash is tested.
122123

123124
When you are done you can close the terminal by closing the view (`ctrl`+`shift`+`q` or `ctrl`+`shift`+`w` as default) or exiting the shell (by e.g. hitting `ctrl`+`d`).
124125

@@ -198,6 +199,27 @@ When you click on *Tools* -> *Build With...* in the menu, you may select the *My
198199

199200
This runs your program inside a TerminalView instead where you can interact with it.
200201

202+
## Integration with other plugins
203+
TerminalView supports integration with other plugins through the **terminal\_view\_send\_string** and **terminal\_view\_exec** commands. The former can be used to send a string to a running terminal while the latter opens a new terminal. For example, to run 'ls' in a terminal that is already open run
204+
205+
```
206+
window.run_command("terminal_view_send_string", {"string": "ls\n"})
207+
```
208+
209+
To run a command in a new terminal run
210+
211+
```
212+
window.run_command("terminal_view_exec", {"cmd": "a.out"})
213+
```
214+
215+
For details refer to the source code for now.
216+
217+
## List of plugins that integrate with TerminalView
218+
The following is a list of known plugins that integrate with TerminalView.
219+
220+
* SendCode by randy3k (https://github.com/randy3k/SendCode)
221+
* ShellVE by bfelder (https://github.com/bfelder/ShellVE)
222+
201223
## Common problems
202224
List of common problems you may encounter when using this plugin.
203225

0 commit comments

Comments
 (0)