> For the complete documentation index, see [llms.txt](https://xircus-developer.gitbook.io/developer-hub/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://xircus-developer.gitbook.io/developer-hub/xircus-cli/quick-start.md).

# Quick Start

## Introduction

Xircus CLI consists of executable command line interface to create web3 apps, compile and publish smart contracts, create and publish skins, create and publish module blocks and upload apps to decentralized file system (IPFS)

### Installation 

{% tabs %}
{% tab title="Yarn" %}

```
yarn add xircus -g
```

{% endtab %}

{% tab title="NPM" %}

```
npm install xircus -g
```

{% endtab %}
{% endtabs %}

### Using Xircus Command on Terminal

After installation, you can start using the node executable:

```
xircus create
```

### Using NPX (Node Package Exectuble)

Alternatively, you can call the xircus executable on the fly using the npx command

```
npx xircus create
```


---

# 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, and the optional `goal` query parameter:

```
GET https://xircus-developer.gitbook.io/developer-hub/xircus-cli/quick-start.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.