mirror of
https://github.com/mudler/LocalAI.git
synced 2026-07-30 09:57:57 -04:00
40d35c0385
* docs: fix CPU image tag (latest, not latest-cpu) Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs: use canonical localai/localai registry in models guide Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs: replace dead llama-stable backend with llama-cpp Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs: correct mitm-proxy intercept config and redaction tier Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs: fix text-to-audio endpoint and broken notice block Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs: fix VAD example, stale FAQ, broken link, CLI list, whats-new dump Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs: render advanced/reference section indexes (consolidate _index) Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs: remove duplicate getting-started build/kubernetes pages Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs: fold container image reference into installation/containers Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs: remove stale advanced fine-tuning page (superseded by features/fine-tuning) Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs: fold distribution/longcat/sound pages into their parents Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs: make getting-started index accurate and complete Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs: carry one concrete model through the getting-started path Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs: add end-to-end 'build your first agent' walkthrough Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs: add runtime errors reference; consolidate troubleshooting from FAQ Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs: add agent actions catalog Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs: agent-scoped MCP, skills walkthrough, agentic disambiguation Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs: add concrete gallery install lines to media feature pages Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs: merge installation into getting-started (URLs preserved via aliases) Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs: add Operations section; move operator pages and P2P API reference Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs: journey-ordered top nav and grouped feature sections Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs: add docs-with-code process gate (PR template + agent instructions) Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs: remove em/en dashes from documentation prose Signed-off-by: Ettore Di Giacinto <mudler@localai.io> --------- Signed-off-by: Ettore Di Giacinto <mudler@localai.io> Co-authored-by: Ettore Di Giacinto <mudler@localai.io>
178 lines
4.3 KiB
Markdown
178 lines
4.3 KiB
Markdown
---
|
|
weight: 7
|
|
title: "References"
|
|
description: "Reference"
|
|
type: chapter
|
|
icon: menu_book
|
|
lead: ""
|
|
date: 2020-10-06T08:49:15+00:00
|
|
lastmod: 2020-10-06T08:49:15+00:00
|
|
draft: false
|
|
images: []
|
|
---
|
|
|
|
## Overview
|
|
|
|
The **References** section provides comprehensive technical documentation for developers and system administrators working with LocalAI. This includes API specifications, command-line reference, architecture details, and compatibility information.
|
|
|
|
### Who Should Read This Section
|
|
|
|
- **API Developers** integrating LocalAI into applications
|
|
- **System Administrators** configuring and maintaining installations
|
|
- **DevOps Engineers** understanding architecture and deployment
|
|
- **Troubleshooters** diagnosing issues and errors
|
|
|
|
---
|
|
|
|
## Topics
|
|
|
|
### 🔌 [API Errors](api-errors.md)
|
|
Complete reference of all API error codes, messages, and troubleshooting guidance.
|
|
|
|
**Key topics:**
|
|
- Error code enumeration
|
|
- Error message formats
|
|
- Common error scenarios
|
|
- Resolution strategies
|
|
|
|
**Recommended for:** Developers handling API responses and errors
|
|
|
|
---
|
|
|
|
### 🏗️ [Architecture](architecture.md)
|
|
Overview of LocalAI's system architecture, components, and data flow.
|
|
|
|
**Key topics:**
|
|
- System components
|
|
- Data flow diagrams
|
|
- Component interactions
|
|
- Design principles
|
|
|
|
**Recommended for:** System architects and advanced users
|
|
|
|
---
|
|
|
|
### 📦 [Binaries](binaries.md)
|
|
Reference documentation for LocalAI binary files and their purposes.
|
|
|
|
**Key topics:**
|
|
- Binary file descriptions
|
|
- Usage instructions
|
|
- File locations
|
|
- Version information
|
|
|
|
**Recommended for:** Users understanding installation structure
|
|
|
|
---
|
|
|
|
### 💻 [CLI Reference](cli-reference.md)
|
|
Complete command-line interface reference with all commands, flags, and examples.
|
|
|
|
**Key topics:**
|
|
- Command enumeration
|
|
- Flag documentation
|
|
- Usage examples
|
|
- Environment variables
|
|
|
|
**Recommended for:** Command-line users and script developers
|
|
|
|
---
|
|
|
|
### 🔄 [Compatibility Table](compatibility-table.md)
|
|
Comprehensive compatibility matrix for models, backends, and platforms.
|
|
|
|
**Key topics:**
|
|
- Model compatibility
|
|
- Backend support matrix
|
|
- Platform requirements
|
|
- Version compatibility
|
|
|
|
**Recommended for:** Users selecting models and configurations
|
|
|
|
---
|
|
|
|
### 🎮 [NVIDIA L4T](nvidia-l4t.md)
|
|
Documentation for NVIDIA Linux for Tegra (L4T) platform support.
|
|
|
|
**Key topics:**
|
|
- L4T platform requirements
|
|
- Installation procedures
|
|
- Configuration options
|
|
- Known issues
|
|
|
|
**Recommended for:** NVIDIA Jetson/Tegra users
|
|
|
|
---
|
|
|
|
### 🔤 [Shell Completion](shell-completion.md)
|
|
Guide to enabling shell completion for LocalAI CLI commands.
|
|
|
|
**Key topics:**
|
|
- Bash completion setup
|
|
- Zsh completion setup
|
|
- Fish completion setup
|
|
- Customization options
|
|
|
|
**Recommended for:** Command-line power users
|
|
|
|
---
|
|
|
|
### 📊 [System Info](system-info.md)
|
|
Reference for system information commands and diagnostics.
|
|
|
|
**Key topics:**
|
|
- System info commands
|
|
- Diagnostic output
|
|
- Hardware detection
|
|
- Performance metrics
|
|
|
|
**Recommended for:** System administrators and troubleshooters
|
|
|
|
---
|
|
|
|
### 🤖 [AI Coding Assistants](ai-coding-assistants.md)
|
|
Policy for AI-assisted contributions: licensing, DCO, and attribution.
|
|
|
|
**Key topics:**
|
|
- Aligned with the Linux kernel's AI assistants policy
|
|
- Signed-off-by and DCO rules
|
|
- `Assisted-by` commit trailer format
|
|
- Scope and responsibility of the human submitter
|
|
|
|
**Recommended for:** Contributors using AI coding assistants (Claude, Copilot, Cursor, Codex, etc.)
|
|
|
|
---
|
|
|
|
## Quick Links
|
|
|
|
| Task | Documentation |
|
|
|------|---------------|
|
|
| API integration | [API Errors](api-errors.md) |
|
|
| CLI commands | [CLI Reference](cli-reference.md) |
|
|
| Check compatibility | [Compatibility Table](compatibility-table.md) |
|
|
| System diagnostics | [System Info](system-info.md) |
|
|
| Contribute with AI assistance | [AI Coding Assistants](ai-coding-assistants.md) |
|
|
|
|
---
|
|
|
|
## Prerequisites
|
|
|
|
Before using reference documentation, ensure you have:
|
|
|
|
1. ✅ LocalAI installed and running
|
|
2. ✅ Basic understanding of APIs and command-line interfaces
|
|
3. ✅ Familiarity with your target platform (Linux, macOS, Windows)
|
|
|
|
---
|
|
|
|
## Related Sections
|
|
|
|
- 📖 [Advanced](../advanced/) - Deep dive into configuration and optimization
|
|
- 🔌 [Installation](../installation/) - Setup and deployment
|
|
- ⭐ [Features](../features/) - Feature overview
|
|
|
|
---
|
|
|
|
## Navigation
|
|
|
|
← [Advanced](../advanced/) | [FAQ](../faq.md) → |