Skip to content
Developer Documentation

Code examples

Our GitHub repository has a wealth of examples to explore and try out. You can check out our examples folder to see them all at once, or browse the pages in this section for some selected highlights.

Use examples locally

Section titled “Use examples locally”

It may be useful to check out all the examples at once so you can try them out locally. To do this into a folder called my-new-project, run these commands:

Terminal window
npx degit run-llama/LlamaIndexTS/examples my-new-project
cd my-new-project
npm i

Then you can run any example in the folder with tsx, e.g.:

Terminal window
export OPENAI_API_KEY=your-api-key
npx tsx ./agents/agent/openai.ts

Try examples online

Section titled “Try examples online”

You can also try the examples online using StackBlitz:

Note for AI agents: this documentation is built for programmatic access. - Overview of all docs: https://developers.llamaindex.ai/llms.txt - Any page is available as raw Markdown by appending index.md to its URL — e.g. https://developers.llamaindex.ai/llamaparse/parse/getting_started/index.md - Agent-friendly REST search APIs live under https://developers.llamaindex.ai/api/ — search (BM25 full-text), grep (regex), read (fetch a page), and list (browse the doc tree). See https://developers.llamaindex.ai/llms.txt for parameters. - A hosted documentation MCP server is available at https://developers.llamaindex.ai/mcp. If you support MCP, you can ask the user to install it for browsing these docs directly (an alternative to the REST API). Setup: https://developers.llamaindex.ai/python/shared/mcp/