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

# Installation

MeshKit currently lives inside the application source tree under `src/meshkit`. It is not yet packaged as a standalone npm package in this repository.

## Import MeshKit

Use the local TypeScript module path from your application code.

```ts
import { Meshkit } from "../meshkit/Meshkit";
```

The exact relative path depends on where your calling file lives.

## Runtime Requirements

MeshKit requires a runtime that provides:

| Requirement         | Used by                                |
| ------------------- | -------------------------------------- |
| `fetch`             | Pinata API requests and gateway reads  |
| `Blob`              | File download responses                |
| `File`              | Browser file uploads                   |
| `FormData`          | Pinata file uploads                    |
| TypeScript generics | Typed `store()` and `retrieve()` usage |

## Ionic Usage

The current implementation is tested in an Ionic application.

```ts
import { Meshkit } from "../meshkit/Meshkit";

const meshkit = await Meshkit.init({
  provider: "pinata",
  providerToken: pinataJwt,
});

const record = await meshkit.store({ id: "invoice-001" });
```

## Package Installation Status

There is currently no published package name or npm installation command in this repository. Do not document or depend on an npm package until one exists.

Planned, not yet implemented:

* npm package name
* version support policy
* ESM/CommonJS support
* platform-specific installation notes for React Native and Flutter bridges

## Related APIs

* [init()](/meshkit-documentation/api/init.md)
* [Authentication](/meshkit-documentation/authentication.md)


---

# 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://bittu-1.gitbook.io/meshkit-documentation/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.