librarian

🥈Silver

Librarian is a CLI tool for coding agents to search up-to-date developer documentation. It supports GitHub repos and public websites, enabling agents to provide accurate code solutions. Ideal for operations teams automating documentation retrieval.

9890Updated 1mo ago

Intermediate30min to implementautomation

Saves ~60 min per use

Quick InstallView Source

git clone https://github.com/iannuttall/librarian.git

Works with:

Claude

Overview

About This Skill

How to Use

1. **Install the Librarian CLI**: Ensure the Librarian tool is installed in your environment by running `pip install librarian-cli` or following the official installation guide for your system. 2. **Run a Search**: Use the CLI to search for documentation on a specific topic. For example: ```bash librarian search --repo=docker/cli --topic="container networking" ``` Replace `--repo` with the GitHub repository or `--website` with a public website URL. 3. **Refine Results**: If the initial search is too broad, add filters like `--language=python` or `--since=2023-01-01` to narrow down results. 4. **Extract Key Information**: Review the returned links and snippets, then copy the most relevant code examples or configurations into your project. 5. **Verify Updates**: Always check the publication date of the documentation to ensure the information is current. Use the `--sort=recent` flag to prioritize the latest updates. Tip: For complex topics, combine multiple searches (e.g., one for setup and another for troubleshooting) to gather comprehensive information.

Setup & Installation

Quick Install

No install command available. Check the GitHub repository for manual installation instructions.

Alternative Install (Git Clone)

git clone https://github.com/iannuttall/librarian

Requirements

Claude Code or compatible AI agent
Works with: Claude

Quick Start Guide

Install the Skill

Copy the install command above and run it in your terminal.

Open Your AI Agent

Launch Claude Code, Cursor, or your preferred AI coding agent.

Try It Out

Use the prompt template or examples below to test the skill.

Customize

Adapt the skill to your specific use case and workflow.

Usage Examples

Prompt Template

Use the Librarian CLI tool to search for [TOPIC] in the documentation of [REPO/WEBSITE]. Focus on finding the most recent and relevant examples, code snippets, or configuration details. Provide a summary of the key findings and include direct links to the most useful resources. If no results are found, suggest alternative sources or keywords to refine the search.

Example Output

After running `librarian search --repo=docker/cli --topic="container networking"`, the tool returned the following results:

1. **Docker Networking Overview** (Updated: 2023-11-15)
   - Link: https://docs.docker.com/network/
   - Key Details: Explains Docker's default bridge network, how to create custom networks, and best practices for container communication. Includes a code snippet for creating an overlay network:
     ```bash
     docker network create --driver=overlay my-overlay-network
     ```

2. **Networking in Docker Compose** (Updated: 2023-10-22)
   - Link: https://docs.docker.com/compose/networking/
   - Key Details: Covers how Docker Compose handles networking, including how services can communicate across different networks. Example snippet:
     ```yaml
     services:
       web:
         networks:
           - frontend
       db:
         networks:
           - backend
     ```

3. **Troubleshooting Docker Networking Issues** (Updated: 2023-09-10)
   - Link: https://docs.docker.com/config/containers/container-networking/
   - Key Details: Provides commands to inspect and debug network configurations, such as `docker network inspect` and `docker exec -it <container> ping <host>`.

The tool also suggested refining the search with keywords like "bridge network" or "host networking" if more specific results are needed.