# Codebox
> "Open source cloud & desktop IDE."

Codebox is a complete and modular Cloud IDE. It can run on any unix-like machine (Linux, Mac OS X). It is an open source component of [codebox.io](https://www.codebox.io) (Cloud IDE as a Service).

The IDE can run on your desktop (Linux or Mac), on your server or the cloud. You can use the [codebox.io](https://www.codebox.io) service to host and manage IDE instances.

![Image](../master/docs/assets/base.png?raw=true)


Codebox is built with web technologies: `node.js`, `javascript`, `html` and `less`. The IDE possesses a very modular and extensible architecture, that allows you to build your own features with through add-ons. Codebox is the first open and modular IDE capable of running both on the Desktop and in the cloud (with offline support).


## Install

Install Codebox globally using NPM:
```
npm install -g codebox
```


## Usage

Run Codebox with:
```
codebox run ./myworkspace
```

Get help and list of commands with:
```
codebox --help
```


## [News](https://twitter.com/CodeboxIO)

Follow updates about Codebox on [Twitter](https://twitter.com/CodeboxIO) and [Youtube](http://www.youtube.com/channel/UCWocQwS2VmDS3Ej0LQYWVIw).


## [Help](../master/docs)

The IDE's documentation can be found in the [docs](../master/docs) folder. Feel free to ask any questions or signal problems by adding issues.


## [Contributing](../master/CONTRIBUTING.md)

Codebox accepts pull-requests, please see the [Contributing to Codebox](../master/CONTRIBUTING.md) guide for information on contributing to this project


## Extras

Screencast: A screencast of the IDE is available on [Youtube](https://www.youtube.com/watch?v=xvPEngyXA2A).


## License

The project is open source under the [Apache 2.0](https://github.com/FriendCode/codebox/blob/master/LICENSE) license.

