Metadata-Version: 2.5
Name: pto-isa-cli
Version: 0.1.0
Summary: Query the PTO-ISA virtual instruction set documentation offline (FTS5, zh/en)
Author: pto-isa-cli contributors
License: MIT License
        
        Copyright (c) 2026 asc-devkit-docs contributors
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Keywords: ascend,cann,cli,documentation,instruction-set,npu,pto-isa
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Documentation
Classifier: Topic :: Utilities
Requires-Python: >=3.10
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == 'dev'
Description-Content-Type: text/markdown

# pto-isa-cli

Query the [PTO-ISA](https://gitcode.com/cann/pto-isa) virtual instruction set documentation from the command line: offline full-text search (FTS5) over all instruction pages, with zh/en language support.

PTO-ISA (Parallel Tile Operation) is the virtual instruction set architecture for Ascend NPU tile operations — the lowest-level semantic reference for high-performance kernel work (TMATMUL, MGATHER, ...).

## Install

```bash
pip install pto-isa-cli
```

## Quick start

```bash
pto-isa init                    # clone pto-isa (shallow) and build the index; ~300 pages
pto-isa read TMATMUL            # read one instruction page (zh by default)
pto-isa read TMATMUL --lang en  # english variant
pto-isa search 矩阵乘法           # full-text search
pto-isa list                    # all instruction names
```

Already have a checkout? `pto-isa --repo /path/to/pto-isa ...` or set `PTO_ISA_REPO`. The index rebuilds automatically when the repository HEAD changes.

This project contains the query client only. Documentation comes from the pto-isa repository at runtime and follows its own license terms.

## License

MIT
