Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Experimental Terminal platform built on WebKit + node.js. Currently only for Mac, though the prototype works 90% in any WebKit browser.
JavaScript PHP Objective-C Python Shell Ruby
Branch: master
Pull request Compare This branch is 25 commits ahead, 7 commits behind unconed:master.

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
Build
Cocoa/TermKit
HTML
Illustrator
Linux
Mockups
Node
Shared
Site
.gitignore
.gitmodules
License.txt
Node-API.md
Readme.md
package.json
sloc.sh
termkit.txt
todo.txt

Readme.md

TermKit

TermKit Icon

Goal: next gen terminal / command application

Built out of WebKit and Node.js.

Runs as a desktop app on Mac, Windows and Linux, and can be hacked into any WebKit browser (Chrome, Safari).

Follow TermKit on Twitter for the latest news and updates.

For the background and architecture, please read and comment on: http://acko.net/blog/on-termkit

TermKit 0.3 alpha TermKit 0.3 alpha TermKit 0.3 alpha

Warning: Alpha version, still under development. Nothing works yet.

Some cool features

  • Smart token-based input with inline autocomplete and automatic escaping
  • Rich output for common tasks and formats, using MIME types + sniffing
  • Asynchronous views for background / parallel tasks
  • Full separation between front/back-end

TermKit is not a...

  • ...Web application. It runs as a regular desktop app.
  • ...Scripting language like PowerShell or bash. It focuses on executing commands only.
  • ...Full terminal emulator. It does not aim to e.g. host 'vim'.
  • ...Reimplementation of the Unix toolchain. It replaces and/or enhances built-in commands and wraps external tools.

(but you could make it do most of those things with plug-ins)

How to use:

Detailed instructions are available from these sources:

Unfortunately, TermKit currently requires some assembly.

  1. Install the Mac development tools (Xcode and friends).
  2. Install node.js and npm.
  3. If not covered in #2, install npm: curl http://npmjs.org/install.sh | sh
  4. Clone the TermKit repository: git clone https://github.com/unconed/TermKit.git --recursive
  5. Users of older git versions will need to type: git submodule update --init
  6. Install node-mime and connect: npm install
  7. Run the NodeKit daemon: cd TermKit/Node; node nodekit.js

Mac:

  • Unzip and run the Mac app in Build/TermKit.zip

Browser:

Linux:

  • See Linux/Readme.txt

Tip: Press ⌥⌘C to access the WebKit console.

API

Preliminary instructions on how to write TermKit native commands can be found here: https://github.com/unconed/TermKit/blob/master/Node-API.md

Credits

TermKit by Steven Wittens (@unconed).

Windows port by James Rhodes (@hachque).

Linux Python/GTK wrapper by Lucas S. Magalhães.

Includes:

Something went wrong with that request. Please try again.