Skip to main content
Glama
README.md
# rndocs

![rndocs banner](banner.png)

**rndocs** is a CLI tool that lets you search and read React Native documentation offline — no browser needed. It downloads the full React Native docs to your machine and gives you instant local search from the terminal.

## Key Features

- Search the entire React Native docs instantly from your terminal
- Read full documentation pages without opening a browser
- Works completely offline after the initial sync
- Integrates with Claude Code and other AI assistants as an MCP server

## Requirements

- Python 3.11 or later
- macOS, Linux, or Windows

## Installation

```bash
pip install rndocs
```

Then download the docs once:

```bash
rndocs sync
```

## Usage

**Search**
```bash
rndocs search "FlatList"
rndocs search "animation"
rndocs search "handle keyboard"
```

**Read a page**
```bash
rndocs get flatlist
rndocs get animated
rndocs get stylesheet
```

**Browse all pages**
```bash
rndocs ls
```

**Refresh docs**
```bash
rndocs sync
```

## Claude Code Integration

Add to your Claude Code MCP settings:

```json
{
  "mcpServers": {
    "rndocs": {
      "command": "rndocs-mcp"
    }
  }
}
```

Claude can now search and read React Native docs directly inside your conversations.

## Contributing

Contributions are welcome! If you've found a bug, have an idea for an improvement, or want to contribute new features, please open an issue or submit a pull request.

## Find this repository useful? :heart:
Support it by joining __[stargazers](https://github.com/androidpoet/rndocs/stargazers)__ for this repository. :star: <br>
Also, __[follow me](https://github.com/androidpoet)__ on GitHub for my next creations! 🤩

TDQS

A4.2/5.0

Scored across 3 tools

Disambiguation5/5

Each tool has a clearly distinct purpose: retrieving a specific doc by slug, listing all docs (optionally filtered), and searching by keyword. No overlap or ambiguity.

Naming Consistency5/5

All tool names follow a consistent verb_noun pattern in snake_case (get_react_native_doc, list_react_native_docs, search_react_native_docs), with singular/plural matching the operation.

Tool Count5/5

Three tools is appropriate for a focused documentation server. Each tool serves a necessary function without redundancy, and the count is not too small or excessive.

Completeness5/5

The tool set covers the essential workflow: discover pages (list and search) and retrieve full content (get). No obvious gaps exist for the stated purpose of accessing React Native docs.

Maintenance

ActivityStale
ResponsivenessNo issues