To get started, you need to sign up for a free Slicknode account (if you haven't already) so that you can deploy your applications to the cloud. Sign up for free
If you already have the Slicknode CLI setup on your system and you have a working Slicknode account, you can skip to the section project setup.
To be able to create Slicknode projects and deploy your application to the cloud, you have to setup the Slicknode CLI on your local machine.
The Slicknode CLI is available via NPM and should be installed globally:
npm install -g slicknode
Afterwards you can test the installation by running the following command in your terminal:
This should print the currently installed version number of slicknode (for example
0.1.2). This is also helpful for
filing bug reports on github
Exploring the Slicknode CLI¶
The Slicknode CLI commands can be explored interactively.
To list all available commands with descriptions, run this command:
To get help and available options for a specific command, use the following:
slicknode help <commandname>
Here you would replace
<commandname> with the command you want to inspect.
For example to get available options and arguments for the
init command, we can use this:
slicknode help init
This works for every command and is automatically updated whenever new functionality is added to Slicknode.
With the Slicknode CLI installed you can create a new project on your local machine. Navigate to the folder in which you want to create the new project, then initialize it:
slicknode init my-project
This might ask you for your login credentials that you provided when you created your Slicknode account in the first step.
The command creates a new folder with the name
my-project and adds the essential files for a Slicknode
project. Afterwards change into the newly created project directory to be able to run the
For all the project specific commands that we are using in the next steps, slicknode by default assumes to apply the command to the project in the current directory.
If you open the project folder in your favorite IDE, you should see the following files:
.slicknode/ slicknode.yml .slicknoderc
slicknode.yml in the root directory of your project serves as the entry point to your
application. This is the place where the dependencies (modules) of your project are defined.
This includes dependencies to core modules as well as dependencies to custom modules that we
are about to create for your blog. It is advised to not edit this file on the root level manually:
Removing a module tells Slicknode for example to remove a module entirely along with all the database tables and data. This cannot be reverted in a lot of cases if it is deployed to the cloud.
The content of a fresh
slicknode.yml file could look something like this:
dependencies: auth: latest core: latest file: latest image: latest relay: latest
.slicknoderc file serves as a store for all the active deployments of the project in the
Slicknode Cloud. It is a JSON object where the keys are the name of the environment (for example
stage) and the configuration itself holds information about the project,
like the ID, the current version etc.
This file should not be edited manually. You should always use the Slicknode CLI commands to create or delete new environments.
Whenever you create a new project, Slicknode automatically creates a
This environment is used whenever you execute a command without the
--env option. Therefore
it is recommended to use the
default environment as your development branch, so that you
don't accidentally deploy unwanted changes to production.
You can later always create more environments for staging, production etc. For now, we just use the default environment.
.slicknode stores cached files to optimize the performance and should not be
edited manually. This folder can also be safely added to your
.gitignore since it only
holds data that can be derived from the project configuration.