README.md

PlatformIO IDE Terminal

A terminal package for Atom, complete with themes, API and more for PlatformIO IDE.

Nucleus Dark UI with Atom Material Syntax and our Homebrew theme.

Install

Ready to install?

You can install via apm: apm install platformio-ide-terminal

Or navigate to the install tab in Atom’s settings view, and search for platformio-ide-terminal.

Caveats

flatpak

Some Atom installations via flatpak may have incompatibilites, including an inability to find host system binaries from select directories, such as /usr/*. If you encounter issues using platformio-ide-terminal with flatpak, such as missing binaries, that are normally accessible from the path you have set in your shell of choice, or if you are not able to change directory into some directories, you may be affected. You can confirm this by looking for the nfsnobody permissions from the root of your disk. You can workaround this by installing another version of atom that is not inside a sandbox container. See here for full details.

Usage

platformio-ide-terminal stays in the bottom of your editor while you work.

Click on a status icon to toggle that terminal (or ctrl-` ). Right click the status icon for a list of available commands. From the right-click menu you can color code the status icon as well as hide or close the terminal instance.

Terminal

You can open the last active terminal with the platformio-ide-terminal:toggle command (Default:ctrl-`). If no terminal instances are available, then a new one will be created. The same toggle command is used to hide the currently active terminal.

From there you can begin typing into the terminal. By default the terminal will change directory into the project folder if possible. The default working directory can be changed in the settings to the home directory or to the active file directory.

See available commands below.

Features

Full Terminal

Every terminal is loaded with your system’s default initialization files. This ensures that you have access to the same commands and aliases as you would in your standard terminal.

Themes

The terminal is preloaded with several themes that you can choose from. Not satisfied?
Use the following template in your stylesheet:

.platformio-ide-terminal .xterm {
  background-color: ;
  color: ;

  ::selection {
    background-color: ;
  }

  .terminal-cursor {
    background-color: ;
  }
}

Process Titles

By hovering over the terminal status icon, you can see which command process is currently running in the terminal.

Terminal Naming

Need a faster way to figure out which terminal is which? Name your status icons!

Available via the status icon context menu.

Color Coding

Color code your status icons!

The colors are customizable in the settings, however the color names remain the same in the context menu.

Sorting

Organize your open terminal instances by dragging and dropping them.

Resizable

You can resize the view vertically, or just maximize it with the maximize button.

Working Directory

You can set the default working directory for new terminals. By default this will be the project folder.

File Dropping

Dropping a file on the terminal will insert the file path into the input. This works with external files, tabs from the Atom tab-view, and entries from the Atom tree-view.

Insert Selected Text

Insert and run selected text from your text editor by running the platformio-ide-terminal:insert-selected-text command (ctrl-enter).

If you have text selected, it will insert your selected text into the active terminal and run it.
If you don't have text selected it, will run the text on the line where your cursor is then proceed to the next line.

Quick Command Insert

Quickly insert a command to your active terminal by executing the platformio-ide-terminal:insert-text command.

A dialog will pop up asking for the input to insert. If you have the Run Inserted Text option enabled in the settings (default is false), platformio-ide-terminal will automatically run the command for you.

Support for Special Keys

Support for IME, dead keys and other key combinations via the Insert Text dialog box. Just click the keyboard button in the top left of the terminal or set up a keymap to the platformio-ide-terminal:insert-text command.

Note: Make sure you have the Run Inserted Command toggle off otherwise it will run your inserted text.

Map Terminal To

Map your terminals to each file or folder you are working on for automatic terminal switching.

File

Folder

Toggling the Auto Open a New Terminal (For Terminal Mapping) option will have the mapping create a new terminal automatically for files and folders that don't have a terminal. The toggle is located right under the Map Terminals To option.

Commands

Command	Action	Default Keybind
platformio-ide-terminal:new	Create a new terminal instance.	ctrl-shift-t or cmd-shift-t
platformio-ide-terminal:toggle	Toggle the last active terminal instance. Note: This will create a new terminal if it needs to.	ctrl-` (Control + Backtick)
platformio-ide-terminal:prev	Switch to the terminal left of the last active terminal.	ctrl-shift-j or cmd-shift-j
platformio-ide-terminal:next	Switch to the terminal right of the last active terminal.	ctrl-shift-k or cmd-shift-k
platformio-ide-terminal:insert-selected-text	Run the selected text as a command in the active terminal.	ctrl-enter
platformio-ide-terminal:insert-text	Bring up an input box for using IME and special keys.	––––––––––––
platformio-ide-terminal:fullscreen	Toggle fullscreen for active terminal.	––––––––––––
platformio-ide-terminal:close	Close the active terminal.	ctrl-shift-x or cmd-shift-x
platformio-ide-terminal:close-all	Close all terminals.	––––––––––––
platformio-ide-terminal:rename	Rename the active terminal.	––––––––––––

---

A fork of jeremyramin/terminal-plus.