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

# Installation

## 1. Install

Install the `file0` npm package. This will be your gateway to your files.\
You can import this package both in the server and client side.

```sh
npm install file0
```

```bash
pnpm add file0
```

```bash
yarn add file0
```

## 2. Connect

Connect to your project by adding your FILE0 app's secret key to you project's env variables.

```bash
F0_SECRET_KEY=f0_sk_*******************
```

**How to obtain the secret key?**

Create an account if you haven't already and copy the key from your app's setup guide.

{% embed url="<https://www.file0.dev/dashboard>" %}
Copy your secret key
{% endembed %}

## 3. Use FILE0 in your code

The environment variable will be automatically detected by the package, so you can start to execute commands right away.

```typescript
import { f0 } from 'file0';

await f0.set('image.png', Buffer.from('My image'));
```


---

# 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://docs.file0.dev/welcome/installation.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.