> For the complete documentation index, see [llms.txt](https://developer.singular.live/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.singular.live/software-development-kits/widget-sdk/preparing-your-environment.md).

# Preparing your environment

### Prerequisites <a href="#prerequisite" id="prerequisite"></a>

The Singular Widget SDK requires a local installation of Node.js. Download it from <https://nodejs.org/en/>.

{% hint style="info" %}
This document describes how to install singular-cli. For details about Singular's other CLIs, singularwidget-cli and singularapp-cli, see <https://github.com/singularlive/> and <https://www.npmjs.com/~singularlive>.
{% endhint %}

### Installing the Singular CLI <a href="#install-singular-cli" id="install-singular-cli"></a>

After installing Node.js, open a console and install `singular-cli` by running this command:

```bash
npm install singular-cli -g
```

After the installing the CLI, console commands to create and deploy Singular widgets and apps will become available.

The `create` commands serve to clone the Singular boilerplates into a specified folder.

The `deploy` commands check, package, and upload your widget or app code to Singular.live. Every widget and app is identified by a unique deploy key. Generating a deploy key is covered [here](https://developer.singular.live/software-development-kits/widget-sdk/getting-started.md#deploying-an-app).

**Create Singular widget boilerplate**

```bash
singular createwidget <folder name>
```

**Deploy a Singular widget**

```bash
singular deploywidget <folder name>
```

For more information about the Singlar.live CLI see <https://github.com/singularlive/singular-cli>.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://developer.singular.live/software-development-kits/widget-sdk/preparing-your-environment.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
