> For the complete documentation index, see [llms.txt](https://docs.stackmate.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackmate.io/guides/installation.md).

# Installation

{% hint style="info" %}
If you need to make stackmate instantly available to your team's workflow without having to install anything, perhaps you should check our [Cloud](https://stackmate.io/cloud/) version. We offer a **trial of 7 days** and **no credit card** is required.
{% endhint %}

Installing stackmate is a simple, straight forward process where all you need is an `npm` client such as `npm` itself or `yarn`

### Installation as a global package through NPM

You can install stackmate through NPM by using the following command:

```
npm install -g @stackmate/stackmate
```

### Installation as a global package through Yarn

Same for yarn:

```
yarn global add @stackmate/stackmate
```

### Direct usage through NPX

We recommend that you install stackmate globally, however if you don't want to or if you just wanna give it a quick spin, feel free to run the package directly through `npx` using the following command:

```
npx @stackmate/stackmate [preview / deploy ...] <environment> [...options]
```

{% hint style="info" %}
Throughout the course of this documentation, we will assume that the package is globally available in the system and we'll be using `stackmate` as our executable
{% endhint %}


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.stackmate.io/guides/installation.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.