> For the complete documentation index, see [llms.txt](https://docs.lazai.network/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.lazai.network/agent-onchain-kit-alith/overview.md).

# Overview

This guide will walk you through everything you need to get started with Alith. Whether you’re building intelligent agents, integrating tools, or experimenting with language models, Alith provides a seamless experience across multiple programming languages. Below, you’ll find installation instructions, quick start guides, and examples for Rust, Python, and Node.js.

### Install Dependency

{% tabs %}
{% tab title="Alith dependency" %}

```sh
npm install alith
# Or use pnpm
pnpm install alith
# Or use yarn
yarn install alith
```

{% endtab %}

{% tab title="json-schema dependency" %}

```sh
npm i --save-dev @types/json-schema
# Or use pnpm
pnpm install --save-dev @types/json-schema
# Or use yarn
yarn install --save-dev @types/json-schema
```

{% endtab %}
{% endtabs %}

### Write the Code

{% code overflow="wrap" %}

```javascript
import { Agent } from "alith";

const agent = new Agent({
  model: "gpt-4",
  preamble: "You are a comedian here to entertain the user using humour and jokes.",
});

console.log(await agent.prompt("Entertain me!"));
```

{% endcode %}

#### Model Provider Settings

To configure different AI model providers, here we use the OpenAI model as an example.

**Unix**

```sh
export OPENAI_API_KEY=<your API key>
```

**Windows**

```powershell
$env:OPENAI_API_KEY = "<your API key>"
```

### Run the Code

```sh
tsc index.ts && node index.js
```


---

# 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.lazai.network/agent-onchain-kit-alith/overview.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.
