Getting started

Get familiar with local development and SiteBox CLI

How to prepare your local machine?

Here is a list of dependencies that are required to make local development possible.

Make sure you have these dependencies installed on your system before attempting to run local development. If you don't have them installed, you can find installation instructions for your operating system in the documentation for each of these tools.

Node.js

Node.js is a development platform that allows running applications written in the JavaScript language outside of a web browser.

To quickly install and use different versions of Node.js we recommend you to use the nvm (for unix, maxOS) or nvm-windows (for Windows).

Git

Git is a version control tool. It helps us track changes in the source code and collaborate with other developers.

Docker

Docker is a containerization tool, which means it packages an application and all its dependencies into a single unit that can be easily moved and run on different environments.

SiteBox CLI

SiteBox CLI is our proprietary tool, designed to facilitate local project development. This tool can be installed and used via the command line, making it a convenient choice for programmers and developers.

SiteBox CLI installation

To begin using the SiteBox CLI tool, you need to install it on your system. To install the SiteBox CLI tool, use the following npm command:

npm install -g @statik-space/statik-cli

This command will install the SiteBox CLI tool globally on your system, making it accessible from anywhere. After the installation is complete, you can check if the tool has been successfully installed by entering:

statik --version

If you see the tool's version number, it means the installation was successful.

The SiteBox CLI tool is a powerful asset for local project development. If you require more detailed information or assistance, use the statik --help command.

The SiteBox CLI tool requires running inside an interactive (TTY) shell for proper functionality. In a non-interactive shell, the SiteBox CLI cannot run, and users cannot send keypress events to the process.

Log in to SiteBox ecosystem

To use the SiteBox CLI tool effectively, you need to log in to your SiteBox account. To log in to your SiteBox account using the SiteBox CLI, enter the following command in your terminal:

statik login

Executing this command will automatically open a new web browser window with the SiteBox login form. You will be prompted to enter your SiteBox account login credentials. After successfully logging in, you will receive a confirmation.

SiteBox Login Form

If the web browser window does not open automatically, you can copy and paste the address displayed in your terminal into the browser's address bar.

After a successful login, close the web browser window and return to the terminal where you initiated the SiteBox CLI tool. After successfully logging in, you will receive a confirmation:

✔ Successfully logged in. (in 26s 209ms)

To check if you are logged in to your SiteBox account, execute the following command:

statik whoami

Now you are ready to work with the SiteBox CLI tool and make the most of its functionalities.

Overview Hosts file