Skip to content

Latest commit

 

History

History
106 lines (73 loc) · 3.3 KB

README.md

File metadata and controls

106 lines (73 loc) · 3.3 KB
Raw

Brackets Terminal X

Brackets extension to integrate the terminal of your choice.

Terminals

Requirements

If you want to install the extension manually you need to install Node.js version 6. Otherwise since v1.0.0 you shouldn't need anything. In earlier versions you needed a C++ compiler installed to your computer.

How to install

Because of adobe/brackets#13312 the latest version is not available in the registry. To get it you have to install it manually. It could take a while to be installed, be patient.

Installing manually

Download a zip of the extension from GitHub through its "Clone or Download" feature. After that:

  • go to your extension folder [1]
  • here extract the zip downloaded before
  • cd brackets-terminal-x-master
  • only if you are on Windows, create a new file named .npmrc [2]
  • run npm install [3]
  • close and reopen Brackets.

[1] Use Help \ Show Extensions Folder or manually
[2] This file is necessary for Windows build until Windows 64 is properly supported.
Its content should be:

arch=ia32
npm_config_arch=ia32
npm_config_target_arch=ia32

[3] Make sure to use the same major version of Node.js used for Brackets. Brackets 1.14 uses Node.js 6.

Report an issue

This extension is based on xterm. Before to report an issue you should verify that you cannot reproduce it with the xterm demo.

Preferences

{
    // Other examples:
    // - C:\\Windows\\sysnative\\WindowsPowerShell\\v1.0\\powershell.exe
    // - C:\\Program Files\\Git\\bin\\bash.exe
    "brackets-terminal-x.shell.windows": "C:\\Windows\\sysnative\\cmd.exe",
    "brackets-terminal-x.shellArgs.windows": [],
    "brackets-terminal-x.shell.mac": "/bin/bash",
    "brackets-terminal-x.shellArgs.mac": [],
    "brackets-terminal-x.shell.linux": "/bin/bash",
    "brackets-terminal-x.shellArgs.linux": [],
    // "dom" or "canvas"
    "brackets-terminal-x.rendererType": "dom",
    // binary to use to run a script for the current file mode
    "brackets-terminal-x.binaries": {
        "javascript": "node",
        "text/x-sh": "sh"
    }
}

NOTE: Brackets preferences do NOT support comments in them.

User Key Bindings

No key binding is set by default.

{
    // Show \ Hide the terminal panel.
    "": "brackets-terminal-x.show",
    // Run focused editor in the terminal.
    "": "brackets-terminal-x.run-script"
}

NOTE: Brackets User Key Bindings do NOT support comments in them.

Known issues

The height of the scrollbar of the terminal is less than the panel.

If you remove the extension from the Extension Manager more likely it will fail. At least on Windows there is an executable running so you will need to clean the remaining files by yourself.

When upgrading most likely you will have the same problems. If so try to remove the extension manually before upgrading.

Thanks

This extension is inspired by https://github.com/artoale/brackets-terminal but built with xterm and node-pty (actually the prebuilt version node-pty-prebuilt)