All help articles

Getting started with the CLI

One of the more powerful features of Laska is its command line interface or CLI. This lets you push and pull files at any time. It is especially useful for having developers and less-technical people like designers collaborate together.

A typical workflow may look like this:

Installing

You can install the CLI through npm or yarn.

npm install -g @laska/cli
yarn global add @laska/cli

Once installed, the CLI can be called using the laska command.

Authentication

The command line tool authenticates through API keys. You need an API key for every project you wish to use the CLI with.

First, create a new folder where you will be working in. If you're starting from scratch this can be an empty folder. If you have an existing project, this will be the folder where your package.json resides.

From inside this folder, run the following command:

laska auth

You'll be asked for your Project Id and an API key. If you haven't created a Laska project yet, create one first.

To generate an API key for your current project, go in to the Project Settings pane in the bottom left of the screen.

Scroll down until you see the New API key button. Note that your Project Id is written right above - you'll need this too.

Press New API key to generate a new key. You'll only see the key once, so make sure to copy it.

Now, go back to your terminal. Once you enter your Project Id and API key, you're ready to go.

Pulling files

To pull files from a Laska project into a local folder, use the laska pull command.

$

Pushing files

To push files from your local folder back to Laska, use the laska push command.

$

If there's additional functionality you'd like to see, please let us know.