Skip to content

Commit 048187c

Browse files
Update README.md
1 parent 6bd76fb commit 048187c

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22

33
The easiest way to get started with [LlamaIndex](https://www.llamaindex.ai/) is by using `create-llama`. This CLI tool enables you to quickly start building a new LlamaIndex application, with everything set up for you.
44

5-
https://github.com/user-attachments/assets/dd3edc36-4453-4416-91c2-d24326c6c167
6-
75
## Get started
86

97
Just run
@@ -12,7 +10,11 @@ Just run
1210
npx create-llama@latest
1311
```
1412

15-
to get started, or see below for more options. Once your app is generated, run
13+
to get started, or watch this video for a demo session:
14+
15+
https://github.com/user-attachments/assets/dd3edc36-4453-4416-91c2-d24326c6c167
16+
17+
Once your app is generated, run
1618

1719
```bash
1820
npm run dev
@@ -22,16 +24,20 @@ to start the development server. You can then visit [http://localhost:3000](http
2224

2325
## What you'll get
2426

25-
- A Next.js-powered front-end using components from [shadcn/ui](https://ui.shadcn.com/). The app is set up as a chat interface that can answer questions about your data (see below)
27+
- A Next.js-powered front-end using components from [shadcn/ui](https://ui.shadcn.com/). The app is set up as a chat interface that can answer questions about your data or interact with your agent
2628
- Your choice of 3 back-ends:
2729
- **Next.js**: if you select this option, you’ll have a full-stack Next.js application that you can deploy to a host like [Vercel](https://vercel.com/) in just a few clicks. This uses [LlamaIndex.TS](https://www.npmjs.com/package/llamaindex), our TypeScript library.
2830
- **Express**: if you want a more traditional Node.js application you can generate an Express backend. This also uses LlamaIndex.TS.
29-
- **Python FastAPI**: if you select this option, you’ll get a backend powered by the [llama-index python package](https://pypi.org/project/llama-index/), which you can deploy to a service like Render or fly.io.
31+
- **Python FastAPI**: if you select this option, you’ll get a backend powered by the [llama-index Python package](https://pypi.org/project/llama-index/), which you can deploy to a service like Render or fly.io.
3032
- The back-end has two endpoints (one streaming, the other one non-streaming) that allow you to send the state of your chat and receive additional responses
3133
- You add arbitrary data sources to your chat, like local files, websites, or data retrieved from a database.
3234
- Turn your chat into an AI agent by adding tools (functions called by the LLM).
3335
- The app uses OpenAI by default, so you'll need an OpenAI API key, or you can customize it to use any of the dozens of LLMs we support.
3436

37+
Here's how it looks like:
38+
39+
https://github.com/user-attachments/assets/d57af1a1-d99b-4e9c-98d9-4cbd1327eff8
40+
3541
## Using your data
3642

3743
You can supply your own data; the app will index it and answer questions. Your generated app will have a folder called `data` (If you're using Express or Python and generate a frontend, it will be `./backend/data`).
@@ -88,14 +94,15 @@ Need to install the following packages:
8894
create-llama@latest
8995
Ok to proceed? (y) y
9096
✔ What is your project named? … my-app
91-
✔ Which template would you like to use?Chat
97+
✔ Which template would you like to use?Agentic RAG (single agent)
9298
✔ Which framework would you like to use? › NextJS
9399
✔ Would you like to set up observability? › No
94100
✔ Please provide your OpenAI API key (leave blank to skip): …
95101
✔ Which data source would you like to use? › Use an example PDF
96102
✔ Would you like to add another data source? › No
97103
✔ Would you like to use LlamaParse (improved parser for RAG - requires API key)? … no / yes
98104
✔ Would you like to use a vector database? › No, just store the data in the file system
105+
✔ Would you like to build an agent using tools? If so, select the tools here, otherwise just press enter › Weather
99106
? How would you like to proceed? › - Use arrow-keys. Return to submit.
100107
Just generate code (~1 sec)
101108
❯ Start in VSCode (~1 sec)

0 commit comments

Comments
 (0)