Skip to content
Snippets Groups Projects
README.md 1.11 KiB
Newer Older
  • Learn to ignore specific revisions
  • # Create LlamaIndex App
    
    The easiest way to get started with LlamaIndex is by using `create-llama`. This CLI tool enables you to quickly start building a new LlamaIndex application, with everything set up for you. 
    To get started, use the following command:
    
    
    ### Interactive
    
    You can create a new project interactively by running:
    
    ```bash
    
    npx create-llama@latest
    
    yarn create llama-app
    
    pnpm create llama-app
    
    Marcus Schiesser's avatar
    Marcus Schiesser committed
    You will be asked for the name of your project, and then which framework you want to use
    
    create a TypeScript project:
    
    ```bash
    
    Marcus Schiesser's avatar
    Marcus Schiesser committed
    ✔ Which framework would you like to use? › NextJS
    
    Marcus Schiesser's avatar
    Marcus Schiesser committed
    You can choose between NextJS and Express.
    
    
    ### Non-interactive
    
    You can also pass command line arguments to set up a new project
    
    non-interactively. See `create-llama --help`:
    
    create-llama <project-directory> [options]
    
    
    Options:
      -V, --version                      output the version number
    
    
      --use-npm
    
        Explicitly tell the CLI to bootstrap the app using npm
    
      --use-pnpm
    
        Explicitly tell the CLI to bootstrap the app using pnpm
    
      --use-yarn
    
        Explicitly tell the CLI to bootstrap the app using Yarn
    
    ```