mirror of
https://github.com/mudler/LocalAI.git
synced 2026-04-30 12:08:13 -04:00
865fd552f5
Align LocalAI with the Linux kernel project's policy for AI-assisted contributions (https://docs.kernel.org/process/coding-assistants.html). - Add .agents/ai-coding-assistants.md with the full policy adapted to LocalAI's MIT license: no Signed-off-by or Co-Authored-By from AI, attribute AI involvement via an Assisted-by: trailer, human submitter owns the contribution. - Surface the rules at the entry points: AGENTS.md (and its CLAUDE.md symlink) and CONTRIBUTING.md. - Publish a user-facing reference page at docs/content/reference/ai-coding-assistants.md and link it from the references index. Assisted-by: Claude:claude-opus-4-7
179 lines
4.4 KiB
Markdown
179 lines
4.4 KiB
Markdown
---
|
|
weight: 23
|
|
title: "References"
|
|
description: "Complete reference documentation"
|
|
type: chapter
|
|
icon: menu_book
|
|
lead: "API documentation, command reference, and technical specifications."
|
|
date: 2020-10-06T08:49:15+00:00
|
|
lastmod: 2026-03-09T00:00:00+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) →
|