tcolar / Goed

GoEd

Goed is a code/text editor, somewhat inspired by Acme. It can run within a terminal or as a standalone lightweight gui.

CURRENT STATE: It's currently in ALPHA and has not been spread around much yet.

I use it as my day to day editor and it "works on my machine"(TM) It has not been tested much beyond that yet, there are many open bugs and TODO's.

Early screenshot (6/2/2015):

Of course typically I have a much large window and resolution such as this screenshot.

Download binaries

You can download prebuilt standalone binaries from bintray here, built using release.sh.

Build from source

If you rather build yourself :

Prerequities:

• Have Go(Golang) installed
• Setup a good monospace terminal font and size (ie: Deja Vu Sans Mono or Monaco, size 10 or so.)

# Have your GOPATH set properly
go get -u github.com/tcolar/goed/cmd/goed

Running goed

Note : goed MUST be in your $PATH !!

which goed        # must be found in your path
goed <path(s)>

Quick start:

• Use right click or Ctrl+N to open a dir/file.
• Use CTRL+T to start a terminal view ($SHELL)
• Use the mouse to resize / move / close views (See "UI" section bellow.)

Terminal use

In theory it should work with any terminal, however the level of support for things like mouse support or extended colors vary a lot.

Terminal - Linux

I recommend GnomeTerminal as it has the best support, but Konsole or Lxterminal should work as well.

Terminal - OSX

I highly recommend a real mouse(2+ buttons) and use ITerm2, do not bother wth Term.app as it has very poor eventing support.

For the best experience, use those ITerm2 settings:

• Under preferences / pointer, disable "right click context menu".
• Under preferences / profiles / default / terminal, set term type to "xterm-256color"
• Under preferences / profiles / dfeault / text, set a nice TTF mono font (ie: 12pt Monaco)

Terminal frontends

The eventing support in terminals varies immensely, some don't support mouse events, some only support some CTRL, ALT sequences and almost none support any type of advanced chording.

For this reason there are alternative terminal frontends see cmd/ The default frontend is goed-tcell(terminal), but there are other implementations goed-termbox (terminal) and goed-wde (GUI) that can be built with build.sh.

For the GUI version, there is a builtin font (LiberationMono) but you can specify the path to a different one in ~/.goed/config.toml, just make sure it's monospace and TTF. ie: GuiFont="/Library/Fonts/Andale Mono.ttf"

Keyboard / Mouse shortcuts

Here are the standard key shortcuts, you can modify those to your liking, note however that terminals support a limited set, in particular on OSX, basically only CTRL combos work properly. Alt and Command combos are not reported by the termbox library used by Goed.

You may use goed --term-events to find out what events work in your given terminal.

You can customize the mouse/keyboard shortcuts in ~/.goed/bindings.toml Here are the standard mouse/keyboard bindings

UI Usage (Mouse)

Each "view" in the UI has a "handle" on the top left corner, either ✔ or ✗, depending if the file is clean or dirty. The top of the view contains the view title "title bar". The left of the view contains the "scroll bar".

There is no real "drag and drop" because very few terminal support that properly, so it's more of a 2 steps operation "select then drop".

• Moving a view: 1) click the handle of the view you want to move 2) click where you want to move it to, either somewhere on the top "title bar" to create a new column, or on an existing view "scroll bar" to move the view into that view's column.

• Swapping views : Double click the "handle" of a view, whichever view was active at the time will swap position with this view.

• Closing a view/column : Click the ✕ button on the view top right.

• Opening a new view : Typically just open an existing file/folder by right clicking it's path. To create a new file the simplest is to open a terminal "Ctrl+T" and "open" the file. o /tmp/test.txt.

Terminal usage

Start a new Terminal with CTRL+T, it will be started in the same path as the current view.

The terminal implements basic vt100 support, enough for things such as top and interactive git to work.

Note that while in a terminal a limited number of global shortcuts are enabled.

Terminal actions

The Terminal provides a few builtin shortcuts, such as:

• o <path> : To open a given path/location in goed (or just right click it)
• s <pattern> [path] : Search text (grep -rni [path])
• f <pattern> [path] : Find files (find -name pattern)
• clear : can be used to fully reset a terminal content.
• sz : Set the shell tty rows/cols to match the current goed view size (should happen automatically).

See res/default/actions for more info.

You may create your own actions in ~/.goed/ations/ (Work In progress)

See res/Readme.md.

Command bar

The command bar is at the top of the screen. you can toggle it by clicking it or using the key, think of it as a minimal one line terminal.

Currently it supports a few things:

• o <path> : Opens a file or directory.
• : <linenumber> : Goes to the secified line.
• / <pattern> : Search pattern (grep)

Anything else will just be executed (via shell) into a new view.

Eventually this will allow for custom defined actions based on patterns.

Configuration

The config file can be edited at ~/.goed/config.toml (The original is under ~/.goed/default/)

Key/Mouse bindings can be customized at ~/.goed/bindings.toml (original under ~/.goed/default/bindings.toml)

You may create custom themes under ~/.goed/themes/ (originals under ~/.goed/default/themes/)

You may create/override actions under ~/.goed/actions/

Reporting issues

Report on github, try not to create duplicates.

If possible try to provide the most recent log found in ~/.goed/log/

Contributing

• Reporting issues is welcome.
• PR's are even better.
• For new functionality a quick discussion first might be best.