Skip to content
A shell console with GUI features
Ruby Emacs Lisp Shell Python JavaScript HTML
Find file
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.



This file shows how to install Xiki. See for a description of Xiki.

Install Xiki

Either install as a gem, or install from github.

As a gem

  $ sudo gem install xiki

Or, from github

  $ git clone
  $ cd xiki
  $ gem install bundler
  $ bundle install --system
  $ cp <xiki dir>/etc/command/xiki_wrapper /usr/local/bin/xiki
  $ chmod 755 /usr/local/bin/xiki

If you don't have permission, to run some of the commands put "sudo" at the beginning of the command.

Verify the 'xiki' shell command works

  $ xiki

It should delay slightly the first time, but be fast subsequent times. If you run into errors and then fix them, you'll want to run the "xiki restart" command.

Configure your editor to use Xiki


If you're going to use Xiki with Emacs, do these steps:

Step 1: Download Emacs

On Mac:

On Linux:

  $ sudo apt-get install emacs

On Windows:

We just patched el4r, so there's a chance Xiki might work in windows.

Step 2: EmacsRuby (el4r) setup

  $ cd <xiki dir>
  $ sudo bash etc/install/

If you're using rvm, the sudo may not be necessary.

If you're using the xiki gem, you can paste this for the above cd:

  $ cd `dirname \`gem contents xiki | grep Gemfile\``

Step 3: Require Xiki in EmacsRuby's config

Sample configuration:

    $LOAD_PATH.unshift "<xiki dir>/lib"
    require 'xiki'

    KeyBindings.keys   # Use default key bindings
    Themes.use "Default"  # Use xiki theme

Be sure to substitute "<xiki dir>" with the actual dir.

If you get an error

If you got partially through the load...

  • You may be able to use these keys to trouble-shoot:
    • Option+e to look at the latest error in the log
    • Option+l to reload xiki and .emacs
      • also use this when you see "el4r-instance is dead"
  • If you can't use the keys, look at the log
    • Named something like: /tmp/el4r......log
    • Go to the end and search backward for the last error
      • probably contains ":Error:"
    • Restart emacs (or reload .emacs) manually to reload
  • See "Issues Loading Xiki" buffer (under "Window" menu bar menu)


Vim support is very partially implemented, but should be pretty straight-forward to implement. It turns out vim is very easy to extend using ruby. See this file to try it out:



There's a simple prototype working, though it's not committed yet.

Other editors

Are you in the bay area and savvy at extending your editor (vim, sublime, textmate, rubymine)? Ping me on the google group and we'll get together and pair on making a Xiki extension for it.

Google group

Join the google group for help with installing, or to chat about whatever or share your ideas:

Something went wrong with that request. Please try again.