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

# 安装及环境配置

## 安装依赖

由于`jorum`中数据流的组织是基于RxJS的，所以需要**同时安装**`rxjs`。

```bash
$ yarn add rxjs jorum
# or
$ npm install rxjs jorum --save
```

## 配置TypeScript

> 目前版本的jorum仅支持TypeScript环境
>
> 欢迎提交PR，实现在JavaScript中使用jorum

在`tsconfig.json`中，加入如下配置：

```javascript
{
  "compilerOptions": {
    "experimentalDecorators": true,
    "emitDecoratorMetadata": true,
    //...
  },
  //...
}
```


---

# 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://jorum.gitbook.io/jorum/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.