lsp-cli 0.0.1

Add your description here

LSP CLI

A powerful command-line interface for the Language Server Agent Protocol (LSAP). lsp-cli provides a bridge between traditional Language Server Protocol (LSP) servers and high-level agentic workflows, offering structured data access and a robust background server management system.

Built on top of lsp-client and LSAP, this tool is designed for developers and AI agents who need reliable, fast, and structured access to language intelligence.

Key Features

• 🚀 Instant Analysis: Quickly get definitions, references, hover info, and completions from the terminal.
• 🏢 Managed Server Lifecycle: A background manager automatically handles language server processes, reusing them across requests for maximum performance.
• 🧩 LSAP Integration: Leverages the Language Server Agent Protocol for structured, agent-friendly responses with built-in pagination and text-based location finding.
• ⚡ Async-First: Built with anyio and asyncer for high-performance concurrent operations.
• 🎨 Rich Output: Beautifully formatted terminal output using rich.

Installation

uv tool install lsp-cli

Quick Start

The main entry point is the lsp command. It automatically detects the appropriate language server for your project.

Find Definition

Find where a symbol is defined:

# Using line scope
lsp definition main.py --scope 10

# Using text search to locate the symbol
lsp definition main.py --find "my_function<HERE>"

# Find declaration instead of definition
lsp def models.py --scope 25 --decl

Get Symbol Information

Get detailed information about a symbol at a specific location:

# Get symbol info at line 15
lsp symbol main.py --scope 15

# Find and get symbol info
lsp sym utils.py --find "UserClass<HERE>"

Find References

Find all references to a symbol:

# Find references to a symbol at line 20
lsp reference models.py --scope 20

# Find references with text search
lsp ref models.py --find "UserClass<HERE>"

# Show more context lines around each reference
lsp reference app.py --scope 10 --context-lines 5

# Find implementations instead of references
lsp reference interface.py --scope 15 --impl

Search Workspace Symbols

Search for symbols across the entire workspace by name:

# Search for symbols containing "MyClass"
lsp search MyClass

# Search in a specific workspace
lsp search "UserModel" --workspace /path/to/project

# Filter by symbol kind
lsp search "test" --kind function --kind method

# Limit results
lsp search "Config" --max-items 10

Get File Outline

Get a hierarchical outline of symbols in a file:

# Get outline of main symbols (classes, functions, methods)
lsp outline main.py

# Include all symbols (variables, parameters, etc.)
lsp outline utils.py --all

Get Hover Information

Get documentation and type information for a symbol:

# Get hover info at a specific line
lsp hover main.py --scope 42

# Find symbol and get hover info
lsp hover models.py --find "process_data<HERE>"

Commands

Command	Description	Alias
definition	Find symbol definition, declaration, or type definition	def
hover	Get hover information (type info, documentation)	-
reference	Find symbol references or implementations	ref
outline	Get a structured symbol outline for a file	-
symbol	Get detailed symbol information at a specific location	sym
search	Search for symbols across the entire workspace by name	-
server	Manage background LSP server processes	-

Server Management

lsp-cli uses a background manager process to keep language servers alive between command invocations. This significantly reduces latency for repeated queries.

# List all running LSP servers
lsp server list

# Manually start a server for a path
lsp server start .

# Stop a server
lsp server stop .

The manager starts automatically when you run any analysis command.

Usage Tips

Locating Symbols

LSP CLI offers flexible ways to locate symbols in your code:

1. Line-based: Use --scope with a line number (1-based)

   lsp definition main.py --scope 42
   

2. Range-based: Specify a line range

   lsp symbol utils.py --scope 10,20
   

3. Text-based: Use --find to search for text with a marker

   lsp hover app.py --find "my_function<HERE>()"
   # The <HERE> marker indicates the cursor position
   

4. Symbol path: Navigate using symbol hierarchy

   lsp definition models.py --scope "UserClass.get_name"
   

Markdown Output

For better readability or integration with documentation tools:

lsp hover main.py --scope 10 --markdown

Working with Results

Pagination for large result sets:

# Get first 50 results
lsp search "config" --max-items 50

# Get next page
lsp search "config" --max-items 50 --start-index 50

Debugging

Enable debug mode to see detailed logs:

lsp --debug definition main.py --scope 10

Configuration

lsp-cli can be configured via environment variables or a config.toml file.

• Config File: ~/.config/lsp-cli/config.toml (on Linux) or ~/Library/Application Support/lsp-cli/config.toml (on macOS).
• Environment Variables: Prefix with LSP_ (e.g., LSP_LOG_DIR=/tmp/logs).

Available Settings

Create a config.toml file at the location above with the following options:

# Enable debug mode (verbose logging)
debug = false

# Idle timeout for managed servers (in seconds)
idle_timeout = 600

# Log level: TRACE, DEBUG, INFO, WARNING, ERROR, CRITICAL
log_level = "INFO"

# Show ASCII art banner on startup
show_banner = true

# Default maximum items for paginated results (search, reference, etc.)
# Set to null for no limit, or a number like 20
default_max_items = 20

# Default number of context lines for reference results
default_context_lines = 2

# Paths to ignore in search results (e.g., virtual environments, build directories)
ignore_paths = [".git", "node_modules", "venv", ".venv", "__pycache__", "dist", "build"]

Environment Variables

All settings can be overridden via environment variables:

export LSP_DEBUG=true
export LSP_LOG_LEVEL=DEBUG
export LSP_DEFAULT_MAX_ITEMS=50
export LSP_SHOW_BANNER=false

Contributing

Contributions are welcome! Please see our Contributing Guide for details on:

• Development setup
• Adding new CLI commands
• Improving the server manager
• Development workflow

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

• lsp-client: The underlying LSP client library.
• LSAP: The Language Server Agent Protocol.
• lsprotocol: LSP type definitions.