> For the complete documentation index, see [llms.txt](https://docs.xyo.network/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.xyo.network/developers/autonomys-data-lake/quickstart.md).

# Public-Library Quickstart

Start an Auto Drive integration using the verified public npm adapter.

This draft deliberately stops at the verified public library boundary. It does not require a command-line wallet, private repository, unpublished package, or internal endpoint.

{% stepper %}
{% step %}

## Prepare a server-side project

Use Node.js 26 for the current public storage package. Keep provider credentials in a protected server or operator environment; never bundle them into browser code.
{% endstep %}

{% step %}

## Install the public adapter

```bash
npm install @xyo-network/archivist-s3@8.0.0
```

Pin the version in deployed applications and review the release before upgrading.
{% endstep %}

{% step %}

## Import the published entry point

```typescript
import {
  createAutoDriveArchivist,
  createAutoDriveS3Client,
} from '@xyo-network/archivist-s3/auto-drive'
```

The documentation checks install this exact public package and confirm both exports are available.
{% endstep %}

{% step %}

## Add application safeguards

Before accepting data, enforce an allowlisted schema, a strict UTF-8 byte limit, authentication and authorization, request-rate limits, and an operation timeout. Treat every retrieved payload as untrusted input.
{% endstep %}

{% step %}

## Verify a complete round trip

Write one bounded test payload, retrieve it through a fresh request, recompute its identity, and compare the exact canonical bytes. A successful write response alone is not proof that the intended content can be retrieved.
{% endstep %}
{% endstepper %}

{% hint style="info" %}
The current storage package uses the 8.x protocol SDK. Do not combine it with the current XL1 SDK's 7.4.x peer line in one runtime until an officially supported compatibility release is available.
{% endhint %}


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.xyo.network/developers/autonomys-data-lake/quickstart.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
