|
1 | | -import { Callout } from '@doc' |
| 1 | +import { Callout, OpenSourceCard, Step, Steps, DocImage } from '@doc' |
| 2 | +import NewProject from "../../assets/new-project.png"; |
| 3 | +import KeysSetup from "../../assets/keys.png"; |
2 | 4 |
|
3 | 5 | # Eliza |
4 | 6 |
|
5 | | -<Callout variant='info' title='Coming Soon'> |
| 7 | +Eliza is a simple, fast, and lightweight AI agent framework to build flexible, scalable, and secure conversational agents. |
6 | 8 |
|
7 | | -We are actively developing plugins to develop with other frameworks and languages. |
| 9 | +With the thirdweb plugin, you can easily integrate Nebula into an AI agent built with Eliza to provide increasingly accurate read, write, and reasoning capabilities to blockchain-related prompts: |
8 | 10 |
|
9 | | -If you have a specific request, please [contact us](https://thirdweb.com/contact). |
| 11 | +<OpenSourceCard |
| 12 | +title="Eliza Plugin" |
| 13 | +href="https://github.com/elizaOS/eliza/tree/main/packages/plugin-thirdweb"/> |
10 | 14 |
|
11 | | - </Callout> |
| 15 | + |
| 16 | +## Prerequisites |
| 17 | + |
| 18 | +- Create a thirdweb account |
| 19 | +- Node.js 23+ and pnpm 9+ installed |
| 20 | + |
| 21 | +## Obtain Client ID & Secret Key |
| 22 | + |
| 23 | +<Steps> |
| 24 | + |
| 25 | +<Step title="Create project"> |
| 26 | + |
| 27 | +Navigate to the [projects dashboard](https://thirdweb.com/) and create a new project. |
| 28 | + |
| 29 | +<DocImage src={NewProject} alt="Create a new project"/> |
| 30 | + |
| 31 | +</Step> |
| 32 | + |
| 33 | +<Step title="Obtain keys"> |
| 34 | + |
| 35 | +Setup your project and obtain your client ID and secret key. Please note your secret key somewhere safe as it is not recoverable. |
| 36 | + |
| 37 | +<Callout variant="warning" title="Client Id vs Secret Key"> |
| 38 | +Client Id is used for client side usage and is restricted by the domain restrictions you set on your API key, it is a public identifier which can be used on the frontend safely. |
| 39 | + |
| 40 | +Secret key is used for server side or script usage and is not restricted by the domain restrictions. Never expose your secret key in client side code. |
| 41 | +</Callout> |
| 42 | + |
| 43 | +<DocImage src={KeysSetup} alt="Obtain keys"/> |
| 44 | + |
| 45 | +</Step> |
| 46 | + |
| 47 | +</Steps> |
| 48 | + |
| 49 | +## Setup Eliza Starter |
| 50 | + |
| 51 | +If you have not created a project with Eliza, it is recommended to start with the Eliza Starter repository: |
| 52 | + |
| 53 | +<Steps> |
| 54 | +<Step title="Clone Starter"> |
| 55 | +<Callout variant='info' title='Version'> |
| 56 | +The Nebula plugin is only available on version 0.1.8 of Eliza and above and is available by default. |
| 57 | +</Callout> |
| 58 | + |
| 59 | +Clone the starter repository |
| 60 | + |
| 61 | +```bash |
| 62 | +git clone https://github.com/elizaos/eliza-starter.git |
| 63 | +``` |
| 64 | +</Step> |
| 65 | + |
| 66 | +<Step title="Environment Variables"> |
| 67 | +Create a .env file and add your secret key and any other environmental variables: |
| 68 | + |
| 69 | +```bash |
| 70 | +THIRDWEB_SECRET_KEY=your_secret_key |
| 71 | +``` |
| 72 | + |
| 73 | +<Callout variant="warning" title="Client Id vs Secret Key"> |
| 74 | +Client Id is used for client side usage and is restricted by the domain restrictions you set on your API key, it is a public identifier which can be used on the frontend safely. |
| 75 | + |
| 76 | +Secret key is used for server side or script usage and is not restricted by the domain restrictions. Never expose your secret key in client side code. |
| 77 | +</Callout> |
| 78 | +</Step> |
| 79 | + |
| 80 | +<Step title="Install Dependencies"> |
| 81 | +```bash |
| 82 | +pnpm i |
| 83 | +``` |
| 84 | +</Step> |
| 85 | + |
| 86 | +<Step title="Start Eliza"> |
| 87 | +```bash |
| 88 | +pnpm start |
| 89 | +``` |
| 90 | +</Step> |
| 91 | + |
| 92 | +</Steps> |
0 commit comments