Skip to content

install.md

Latest commit

 

History

History
104 lines (83 loc) · 2.92 KB

install.md

File metadata and controls

104 lines (83 loc) · 2.92 KB

Xone Installation (recommended)

> npm install -g xone

Note: To make the Xone CLI globally available, you have to install Xone as a global npm module (also in addition to any local installation if you want to keep simple as most as possible). You can also manage multiple/custom versions of Xone as well as using the CLI without any global installations (read further).

Note: Xone binaries typically has to be installed via "xone create" or "xone install" to make full advantage of the build system and also comes with its own pre-defined folder structure (followed by some conventions). We will provide a stand-alone version optionally to skip as many conventions as possible (e.g. Xone acts like an extern Javascript Plugin). We recommended to use the full Xone build capabilities (read further).

Create new Xone project

Create a new project inside the directory workspace\my_project:

workspace> xone create "my_project"

Create a new project inside the current directory:

workspace\my_project> xone create .

Force overwrite an existing Xone project:

workspace\my_project> xone create . --force

Note: Be careful, this command will also reset most of the existing project files!

Update existing Xone project (fetches from global npm_modules installation)

Fetch update:

> npm install -g xone

Install update to an existing project

workspace\my_project> xone install

Manage multiple versions

Install local version of xone:

> npm install xone@0.2.1

Compare current installed, local and global npm versions of Xone:

> xone version --current
> xone version --global
> xone version --local

Update Xone binaries of an existing Xone project (fetch from a local npm_modules installation):

workspace\my_project> xone install local

Update Xone binaries of an existing Xone project (fetch from any custom location):

workspace\my_project> xone install /lib/xone_0.2.1/

Note: To make the Xone CLI available (use the keyword 'xone') it needs at least one global Xone installation. Please read further if you prefer an installation without using the Xone CLI.

Manage local npm repositories of Xone (without using Xone CLI):

Install Xone locally:

workspace\my_project> npm install xone

Create new Xone project (the dot indicates the current directory):

workspace\my_project> node node_modules\xone\create .

Update existing Xone project:

workspace\my_project> node node_modules\xone\install

Alternatively you can use a Xone repository located in any folder (e.g. fetched via Git)

Check Xone installation (example):

lib\xone_0.2.1> node version

Create a new project:

workspace> node ../lib/xone_0.2.1/create "my_project"

Update an existing project:

workspace\my_project> node ../lib/xone_0.2.1/install