Welcome to LLxprt Code documentation

This documentation provides a comprehensive guide to installing, using, and developing LLxprt Code. This tool lets you interact with Gemini models through a command-line interface.

Overview

LLxprt Code brings the capabilities of large language models to your terminal in an interactive Read-Eval-Print Loop (REPL) environment. LLxprt Code consists of a client-side application (packages/cli) that communicates with a local server (packages/core), which in turn manages requests to the provider APIs and its AI models. LLxprt Code also contains a variety of tools for tasks such as performing file system operations, running shells, and web fetching, which are managed by packages/core.

Navigating the documentation

This documentation is organized into the following sections:

• Execution and Deployment: Information for running LLxprt Code.
• Architecture Overview: Understand the high-level design of LLxprt Code, including its components and how they interact.
• CLI Usage: Documentation for packages/cli.
  • CLI Introduction: Overview of the command-line interface.
  • Commands: Description of available CLI commands.
  • Configuration: Information on configuring the CLI.
  • Runtime helper APIs: Reference for runtime-scoped helper functions.
  • Authentication: Set up authentication for various providers.
  • OAuth Setup: Configure OAuth authentication for providers.
  • Provider Configuration: Configure and manage LLM providers.
  • OpenAI Responses API: Using OpenAI's enhanced Responses API.
  • Local Models: Complete guide to using local AI models with LM Studio, Ollama, llama.cpp, and more.
  • Prompt Configuration: How to customize AI behavior with prompts.
  • Settings and Profiles: How to manage settings and use profiles.
  • Emoji Filter: Control emoji usage in LLM responses.
  • Themes: Customize the visual appearance.
  • Keyboard Shortcuts: Quick reference for keyboard shortcuts.
  • Checkpointing: Documentation for the checkpointing feature.
  • Extensions: How to extend the CLI with new functionality.
  • IDE Integration: Connect the CLI to your editor.
  • Telemetry: Overview of telemetry in the CLI.
  • Telemetry Privacy: Privacy information for telemetry.
• Core Details: Documentation for packages/core.
  • Core Introduction: Overview of the core component.
  • Provider runtime context: Manage ProviderRuntimeContext lifecycles.
  • Provider interface: Implement providers against the stateless runtime.
  • Tools API: Information on how the core manages and exposes tools.
  • Memory Import Processor: Modular LLXPRT.md import feature.
• Tools:
  • Tools Overview: Overview of the available tools.
  • File System Tools: Documentation for the read_file and write_file tools.
  • Multi-File Read Tool: Documentation for the read_many_files tool.
  • Shell Tool: Documentation for the run_shell_command tool.
  • MCP Server: Model Context Protocol server integration.
  • Web Fetch Tool: Documentation for the web_fetch tool.
  • Web Search Tool: Documentation for the google_web_search tool.
  • Memory Tool: Documentation for the save_memory tool.
• Additional Resources:
  • Sandbox Security: Security and sandboxing mechanisms.
  • Shell Replacement: Command substitution in shell commands.
  • Contributing & Development Guide: Information for contributors and developers.
  • NPM Workspaces and Publishing: Details on how the project's packages are managed and published.
  • Release notes: Stateless Provider: Summary of new runtime features, breaking changes, and validation steps.
  • Troubleshooting Guide: Find solutions to common problems and FAQs.
  • Migration from Gemini CLI: Guide for users migrating from Gemini CLI.
  • Stateless provider migration: Upgrade guide for the new provider runtime model.
  • Terms of Service and Privacy Notice: Information on the terms of service and privacy notices.

We hope this documentation helps you make the most of the LLxprt Code!