Back to Localai

Index.En

docs/content/getting-started/_index.en.md

4.8.01.6 KB
Original Source

+++ disableToc = false title = "Getting started" weight = 2 icon = "rocket_launch" type = "chapter" +++

Welcome to LocalAI! This section takes you from a fresh install to a working chat, a working API call, and your first customized model. Follow the pages in order the first time through; each one builds on the previous.

{{% notice tip %}} Haven't installed LocalAI yet?

See the [Installation guide]({{% relref "getting-started/install" %}}) first. Docker is the recommended installation method for most users. {{% /notice %}}

The path

  1. Install LocalAI (see the [Installation guide]({{% relref "getting-started/install" %}})).
  2. [Quickstart]({{% relref "getting-started/quickstart" %}}) - start LocalAI, install your first model, and get your first chat reply from both the web interface and the API.
  3. [Install and run models]({{% relref "getting-started/models" %}}) - the different ways to install models (gallery, Hugging Face, OCI, local files) and run them.
  4. [Try it out]({{% relref "getting-started/try-it-out" %}}) - copy-paste examples for every OpenAI-compatible endpoint (chat, vision, functions, audio, images, embeddings).
  5. [Customize models]({{% relref "getting-started/customize-model" %}}) - edit model configuration and prompt templates to tune behavior.
  6. [Troubleshooting]({{% relref "getting-started/troubleshooting" %}}) - fixes for the most common install and startup problems.

Once you have a model answering, the [Build your first agent]({{% relref "getting-started/first-agent" %}}) walkthrough shows how to turn that model into an autonomous agent that can use tools.