> ## Documentation Index
> Fetch the complete documentation index at: https://persian-tools.usestrict.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Persian Tools

> A comprehensive, high-performance TypeScript toolkit for Persian (Farsi) text, numbers, validation, and locale utilities

# Welcome to Persian Tools

Persian Tools is a **comprehensive, library-agnostic TypeScript toolkit** designed specifically for Persian (Farsi) language applications. It provides 27+ utilities for text processing, number conversion, validation, and locale-specific operations.

<CardGroup cols={2}>
  <Card title="Quick Start" icon="rocket" href="/getting-started/installation">
    Get up and running in minutes
  </Card>

  <Card title="Number Conversion" icon="calculator" href="/utilities/numbers/number-to-words">
    Convert between Persian words and numbers
  </Card>

  <Card title="Validation" icon="shield-check" href="/utilities/validation/national-id">
    Validate Iranian IDs, cards, and more
  </Card>

  <Card title="Text Processing" icon="text" href="/utilities/text/persian-chars">
    Process and validate Persian text
  </Card>
</CardGroup>

## Why Persian Tools?

<AccordionGroup>
  <Accordion title="🚀 High Performance" icon="gauge-high">
    Optimized algorithms with zero dependencies. Works seamlessly in Node.js, Bun, and browsers.
  </Accordion>

  <Accordion title="📦 Tree-Shakable" icon="tree">
    Import only what you need. Modern bundlers automatically eliminate unused code.
  </Accordion>

  <Accordion title="🔒 Type-Safe" icon="shield">
    Written in TypeScript with strict typing. Get autocomplete and type checking out of the box.
  </Accordion>

  <Accordion title="✅ Battle-Tested" icon="vial">
    Over 80% test coverage with comprehensive edge case handling.
  </Accordion>
</AccordionGroup>

## Features Overview

### 🔢 Numbers & Text

* **Number Conversion**: Persian words ↔ numbers with fuzzy matching
* **Digit Conversion**: Persian ↔ Arabic ↔ English digits
* **Comma Formatting**: Add/remove thousands separators
* **Ordinal Numbers**: Convert to/from ordinal forms (اول، دوم، سوم)

### 🏛️ Validation & Verification

* **National ID**: Validate & generate Iranian national codes (کد ملی)
* **Legal ID**: Validate Iranian legal entity IDs (شناسه حقوقی)
* **Phone Numbers**: Validate & extract operator information
* **Bank Cards**: Validate & identify bank names
* **IBAN/Sheba**: Validate Iranian bank account numbers

### 🌍 Geographic & Location

* **Place Lookup**: Find city/province by national ID
* **Capital Cities**: Get province capitals
* **Coordinates**: Find province from GPS coordinates
* **Vehicle Plates**: Parse Iranian license plates

### 💰 Financial & Utilities

* **Bill Calculator**: Parse Iranian utility bills
* **Bank Detection**: Identify banks from card numbers
* **IBAN Tools**: Complete Iranian banking support

### 📝 Text Processing

* **Persian Validation**: Detect pure Persian text
* **Character Cleanup**: Remove Arabic characters from Persian
* **URL Fixing**: Decode Persian URLs
* **Half-Space**: Fix Persian typography
* **Time Utilities**: Persian time-ago & remaining time
* **Slugify**: Generate URL-safe slugs from Persian text
* **Text Analysis**: Comprehensive Persian text analysis

## Community & Support

<CardGroup cols={3}>
  <Card title="GitHub" icon="github" href="https://github.com/persian-tools/persian-tools">
    Star us on GitHub
  </Card>

  <Card title="NPM Package" icon="npm" href="https://www.npmjs.com/package/@persian-tools/persian-tools">
    View on NPM
  </Card>

  <Card title="Contributing" icon="code-pull-request" href="https://github.com/persian-tools/persian-tools/blob/master/CONTRIBUTING.md">
    Contribute to the project
  </Card>
</CardGroup>

## Who's Using Persian Tools?

Persian Tools is trusted by leading organizations including banks, fintech companies, and startups across Iran and beyond.

<Card title="See Who's Using Persian Tools" icon="building" href="/showcase">
  Discover the companies and projects building amazing applications with Persian Tools, including **Bank Maskan**,
  **Maani**, **Melkba**, and more.
</Card>

## License

Persian Tools is [MIT licensed](https://github.com/persian-tools/persian-tools/blob/master/LICENSE).