Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/unconed/TermKit
Experimental Terminal platform built on WebKit + node.js. Currently only for Mac and Windows, though the prototype works 90% in any WebKit browser.
https://github.com/unconed/TermKit
Last synced: about 2 months ago
JSON representation
Experimental Terminal platform built on WebKit + node.js. Currently only for Mac and Windows, though the prototype works 90% in any WebKit browser.
- Host: GitHub
- URL: https://github.com/unconed/TermKit
- Owner: unconed
- License: other
- Created: 2010-07-21T22:08:27.000Z (about 14 years ago)
- Default Branch: master
- Last Pushed: 2011-12-15T20:30:22.000Z (almost 13 years ago)
- Last Synced: 2024-05-11T10:35:49.091Z (4 months ago)
- Language: JavaScript
- Homepage: http://acko.net/
- Size: 47.3 MB
- Stars: 4,435
- Watchers: 125
- Forks: 238
- Open Issues: 33
-
Metadata Files:
- Readme: Readme.md
- License: License.txt
Awesome Lists containing this project
README
# TermKit
### 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](https://twitter.com/TermKit) for the latest news and updates.
For the background and architecture, please read and comment on:
http://acko.net/blog/on-termkit
### 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:
* [Mac OS X (OS X Daily)](http://osxdaily.com/2011/05/19/termkit-terminal-reimagined-how-to-install/)
* [Windows (Redpoint blog)](http://blog.redpointsoftware.com.au/termkit/)
* [Linux, Python GTK](https://github.com/unconed/TermKit/tree/master/Linux)
* [Linux, Chrome only (Easytech blog)](http://blog.easytech.com.ar/2011/05/21/playing-with-termkit-with-chrome/)
Unfortunately, TermKit currently requires some assembly.
1. Install the Mac development tools (Xcode and friends).
2. [Install node.js](https://github.com/joyent/node/wiki/Installation).
3. If not covered in #2, install npm: `curl http://npmjs.org/install.sh | sh`
4. Install node-mime: `npm install mime`
5. Clone the TermKit repository: `git clone https://github.com/unconed/TermKit.git --recursive`
6. Users of older git versions will need to type: `git submodule update --init`
7. Run the NodeKit daemon: `cd TermKit/Node; node nodekit.js`
Mac:
* Unzip and run the Mac app in Build/TermKit.zip
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](http://acko.net) ([@unconed](https://twitter.com/unconed)).
Windows port by James Rhodes ([@hachque](https://twitter.com/hachque)).
Linux Python/GTK wrapper by [Lucas S. Magalhães](https://github.com/lucassmagal).
Includes:
* “NSImage+QuickLook” by Matt Gemmell (http://mattgemmell.com/source).
* SyntaxHighlighter by Alex Gorbatchev (http://alexgorbatchev.com/SyntaxHighlighter/)
* jQuery and jQuery UI