> For the complete documentation index, see [llms.txt](https://yinglinhan.gitbook.io/framer-x-api/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://yinglinhan.gitbook.io/framer-x-api/jie-shao/kuai-su-kai-shi/kuai-su-kai-shi.md).

# 快速开始

#### 安装

Framer API被设计为与Framer X这个软件协作，但是它也是一个很棒的独立的JS的库。你可以通过你电脑的命令行工具使用npm安装它。

```bash
// Install Framer via command line
npm install framer
```

####

#### 引入

一旦你安装完成，你就可以把这个库引入到你的文件里

```typescript
// Import from Framer
import { Frame, Scroll, useCycle } from "framer"
```

#### Framer X

学习如何在FramerX里面使用Framer API，你可以看一下这个简短的**Framer Playground** 的视频教程。它主要包括以下几个方面的内容。

 \- 如何创建代码组件

 \- 代码组件在哪里起作用

 \- 如何预览代码组件

 \- 如何预览你的项目

 \- 如何查错

{% embed url="<https://youtu.be/YSLU5KCiZWE>" %}


---

# 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://yinglinhan.gitbook.io/framer-x-api/jie-shao/kuai-su-kai-shi/kuai-su-kai-shi.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.